Welcome to little lamb

Code » limb » master » tree

[master] / src / doc / u16.h / u16.h.0.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
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
% limb manual
% u16.h(0)
% limb 0.1.0
% 2023-07-24

# NAME

u16.h - 16bit unsigned integers

# SYNOPSIS

    #include <limb/u16.h>

# DESCRIPTION

This header defines functions allowing to work with 16bit unsigned integers.

## Constants

The following constants are defined :

: *U16_FMT*
:: Maximum length for a byte array that can hold an u16 value in decimal
:: representation, plus a NUL-terminating byte

: *U16_FMTG*
:: Same as *U16_FMT* but with thousand-separators

: *U16_BFMT*
:: Same as *U16_FMT* but for binary

: *U16_OFMT*
:: Same as *U16_FMT* but for octal

: *U16_XFMT*
:: Same as *U16_FMT* but for hexadecimal

## Functions

The following functions/macros are defined :

: [u16_be](3)
:: Convert a u16 number to big endian.

: [u16_le](3)
:: Convert a u16 number to little endian.

: [u16p_be](3)
:: Similar to [u16_be](3) but takes a pointer.

: [u16p_le](3)
:: Similar to [u16_le](3) but takes a pointer.

: [u16pa_be](3)
:: Similar to [u16p_be](3) but for an array of pointers.

: [u16pa_le](3)
:: Similar to [u16p_le](3) but for an array of pointers.

: [u16_pack](3)
:: Store a u16 number encoded in little endian.

: [u16_unpack](3)
:: Read a u16 number encoded in little endian.

: [u16_pack_big](3)
:: Store a u16 number encoded in big endian.

: [u16_unpack_big](3)
:: Read a u16 number encoded in big endian.

: [u16_fmt](3)
:: Write a u16 number as decimal into a byte array.

: [u16_fmtg](3)
:: Write a u16 number as decimal, using coma as thousand separator, into a
:: byte array.

: [u16_bfmt](3)
:: Similar to [u16_fmt](3) but as binary.

: [u16_ofmt](3)
:: Similar to [u16_fmt](3) but as octal.

: [u16_xfmt](3)
:: Similar to [u16_fmt](3) but as hexadecimal.

: [u16_0fmt](3)
:: Similar to [u16_fmt](3) but filling with zeroes if less than given size.

: [u16_0fmtg](3)
:: Similar to [u16_fmtg](3) but filling with zeroes if less than given size.

: [u16_0bfmt](3)
:: Similar to [u16_bfmt](3) but filling with zeroes if less than given size.

: [u16_0ofmt](3)
:: Similar to [u16_ofmt](3) but filling with zeroes if less than given size.

: [u16_0xfmt](3)
:: Similar to [u16_xfmt](3) but filling with zeroes if less than given size.

: [u16_scan](3)
:: Read a u16 value from a byte array.

: [u16_bscan](3)
:: Similar to [u16_scan](3) but for binary value.

: [u16_oscan](3)
:: Similar to [u16_scan](3) but for octal value.

: [u16_xscan](3)
:: Similar to [u16_scan](3) but for hexadecimal value.

: [u16_scan0](3)
:: Similar to [u16_scan](3) but expects a NUL-terminated string.

: [u16_bscan0](3)
:: Similar to [u16_bscan](3) but expects a NUL-terminated string.

: [u16_oscan0](3)
:: Similar to [u16_oscan](3) but expects a NUL-terminated string.

: [u16_xscan0](3)
:: Similar to [u16_xscan](3) but expects a NUL-terminated string.