Zig 0.17.0-dev (Split by item) This is an example of documentation generated by
ZigDoc , an alternative to Zig's built-in
Auto Doc feature. See also
examples in other modes/formats . The project being documented here (as the example) is the Zig standard library.
std › fmt › float › formatDecimal Public Function formatDecimal Doc Source Public Function std.fmt.float.formatDecimal
pub fn formatDecimal (comptime T : type , buf : []u8 , f_ : FloatDecimal (T ), precision : ?usize ) Error ![]const u8 Params Errors File fmt/float.zig: 266
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354 pub fn formatDecimal (comptime T : type , buf : []u8 , f_ : FloatDecimal (T ), precision : ?usize ) Error ![]const u8 {
std .debug .assert (buf .len >= min_buffer_size );
var f = f_ ;
if (f .exponent == special_exponent ) {
return copySpecialStr (buf , f );
}
if (precision ) |prec | {
f = round (T , f , .decimal , prec );
}
var output = f .mantissa ;
const olength = decimalLength (output );
// fixed bound: leading_digit(1) + point(1)
const req_bytes = if (f .exponent >= 0 )
@as (usize , 2 ) + @abs (f .exponent ) + olength + (precision orelse 0 )
else
@as (usize , 2 ) + @max (@abs (f .exponent ) + olength , precision orelse 0 );
if (buf .len < req_bytes ) {
return error .BufferTooSmall ;
}
// Step 5: Print the decimal representation
var index : usize = 0 ;
if (f .sign ) {
buf [index ] = '-' ;
index += 1 ;
}
const dp_offset = f .exponent + cast_i32 (olength );
if (dp_offset <= 0 ) {
// 0.000001234
buf [index ] = '0' ;
buf [index + 1 ] = '.' ;
index += 2 ;
const dp_index = index ;
const dp_poffset : u32 = @intCast (-dp_offset );
@memset (buf [index ..][0 ..dp_poffset ], '0' );
index += dp_poffset ;
writeDecimal (buf [index ..], &output , olength );
index += olength ;
if (precision ) |prec | {
const dp_written = index - dp_index ;
if (prec > dp_written ) {
@memset (buf [index ..][0 .. prec - dp_written ], '0' );
}
index = dp_index + prec - @intFromBool (prec == 0 );
}
} else {
// 123456000
const dp_uoffset : usize = @intCast (dp_offset );
if (dp_uoffset >= olength ) {
writeDecimal (buf [index ..], &output , olength );
index += olength ;
@memset (buf [index ..][0 .. dp_uoffset - olength ], '0' );
index += dp_uoffset - olength ;
if (precision ) |prec | {
if (prec != 0 ) {
buf [index ] = '.' ;
index += 1 ;
@memset (buf [index ..][0 ..prec ], '0' );
index += prec ;
}
}
} else {
// 12345.6789
writeDecimal (buf [index + dp_uoffset + 1 ..], &output , olength - dp_uoffset );
buf [index + dp_uoffset ] = '.' ;
const dp_index = index + dp_uoffset + 1 ;
writeDecimal (buf [index ..], &output , dp_uoffset );
index += olength + 1 ;
if (precision ) |prec | {
const dp_written = olength - dp_uoffset ;
if (prec > dp_written ) {
@memset (buf [index ..][0 .. prec - dp_written ], '0' );
}
index = dp_index + prec - @intFromBool (prec == 0 );
}
}
}
return buf [0 ..index ];
}
Write a FloatDecimal to a buffer in decimal form.
The buffer provided must be greater than
min_buffer_sizebytes in length. If no precision is specified, this may still return an error. If precision is specified,2 + precisionbytes will always be written.