Merge pull request #939 from dibdot/master
[project/luci.git] / libs / luci-lib-nixio / docsrc / nixio.bin.lua
1 --- Binary operations and conversion.
2 module "nixio.bin"
3
4 --- Return a hexadecimal ASCII represantation of the content of a buffer. 
5 -- @class function
6 -- @name hexlify
7 -- @param buffer        Buffer
8 -- @return representation using characters [0-9a-f]
9
10 --- Return a binary buffer from a hexadecimal ASCII representation. 
11 -- @class function
12 -- @name unhexlify
13 -- @param hexvalue representation using characters [0-9a-f]
14 -- @return binary data
15
16 --- Calculate the CRC32 value of a buffer. 
17 -- @class function
18 -- @name crc32
19 -- @param buffer        Buffer
20 -- @param initial       Initial CRC32 value (optional)
21 -- @return crc32 value
22
23 --- Base64 encode a given buffer.
24 -- @class function
25 -- @name b64encode
26 -- @param buffer        Buffer
27 -- @return base64 encoded buffer
28
29 --- Base64 decode a given buffer.
30 -- @class function
31 -- @name b64decode
32 -- @param buffer        Base 64 Encoded data
33 -- @return binary data