lfe/doc/lfe_bits.txt at develop · dokkarr/lfe · GitHub

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
MODULE

	lfe_bits

MODULE SUMMARY

	Lisp Flavoured Erlang (LFE) common binary functions

DESCRIPTION

	This module contains a collection of library functions for for
	handling binaries. They are generally not called by the user.

EXPORTS

parse_bitspecs(Specs) ->
	{ok,Size,{Type,Unit,Sign,Endian}} |
	{error,Error}.

	Parse a bitspec and return the data. Unmentioned fields get
	the value 'default'.

get_bitspecs(Specs) ->
	{ok,Size,{Type,Unit,Sign,Endian}} |
	{error,Error}.

	Parse a bitspec, apply defaults and return the
	data. Unmentioned fields get the value 'default'.

Error Information

	The following error values are returned:

	{undefined_bittype,Type}
	bittype_unit