Welcome to little lamb

Code » limb » release » tree

[release] / src / doc / u16.h / u16_fmt.3.md 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
% limb manual
% u16_fmt(3)
% limb 0.1.0
% 2023-07-24

# NAME

u16_fmt, u16_fmtg, u16_0fmt - write an u16 as decimal value into a byte array

u16_xfmt, u16_0xfmt - write an u16 as hexadecimal value into a byte array

u16_ofmt, u16_0ofmt - write an u16 as octal value into a byte array

u16_bfmt, u16_0bfmt - write an u16 as binary value into a byte array


# SYNOPSIS

    #include <limb/u16.h>

```pre hl
size_t u16_fmt(char *<em>s</em>, u16 <em>u</em>)
size_t u16_0fmt(char *<em>s</em>, u16 <em>u</em>, size_t <em>min</em>)

size_t u16_fmtg(char *<em>s</em>, u16 <em>u</em>)
size_t u16_0fmtg(char *<em>s</em>, u16 <em>u</em>, size_t <em>min</em>)

size_t u16_xfmt(char *<em>s</em>, u16 <em>u</em>)
size_t u16_0xfmt(char *<em>s</em>, u16 <em>u</em>, size_t <em>min</em>)

size_t u16_ofmt(char *<em>s</em>, u16 <em>u</em>)
size_t u16_0ofmt(char *<em>s</em>, u16 <em>u</em>, size_t <em>min</em>)

size_t u16_bfmt(char *<em>s</em>, u16 <em>u</em>)
size_t u16_0bfmt(char *<em>s</em>, u16 <em>u</em>, size_t <em>min</em>)
```

# DESCRIPTION

The `u16_fmt`() macro will write into `s` the value of `u` in decimal.
The `u16_0fmt`() macro will write into `s` the value of `u` in decimal,
prefixing it with leading zeroes if it requires less than `min` characters to do
so.

The `u16_fmtg`() and `u16_0fmtg`() macros are similar, only they will use a
coma (`,`) as thousand separator as needed.

The `u16_xfmt`() and `u16_0xfmt`() macros are similar, only putting the value
of `u` in hexadecimal.

The `u16_ofmt`() and `u16_0ofmt`() macros are similar, only putting the value
of `u` in octal.

The `u16_bfmt`() and `u16_0bfmt`() macros are similar, only putting the value
of `u` in binary.

It is possible to use `NULL` as `s` to only have length computation performed.

! INFO: Generic functions
! Note that those are macros to [u64_fmt_generic](3) and [u64_0fmt_generic](3).

## Constants

Some constants are available if needed, e.g. to allocate a buffer large enough :

: *U16_FMT*
:: Maximum number of `char` needed to hold a decimal string

: *U16_FMTG*
:: Maximum number of `char` needed to hold a thousand-separated decimal string

: *U16_XFMT*
:: Maximum number of `char` needed to hold an hexadecimal string

: *U16_OFMT*
:: Maximum number of `char` needed to hold an octal string

: *U16_BFMT*
:: Maximum number of `char` needed to hold a binary string

Note that all of those include an extra `char` for a proper NUL-terminated
string.

# RETURN VALUE

All of these return the length of the string written into `s`, or required to
do so when `s` is `NULL`