Current section
Files
Jump to
Current section
Files
doc/man/lfe_bits.3
.\" Automatically generated by Pandoc 2.11.2
.\"
.TH "lfe_bits" "3" "2011-2016" "" ""
.hy
.SH NAME
.PP
lfe_bits - Lisp Flavoured Erlang (LFE) common binary functions
.SH SYNOPSIS
.PP
This module contains a collection of library functions for for handling
binaries.
They are generally not called by the user.
.SH EXPORTS
.PP
\f[B]parse_bitspecs(Specs) ->\f[R]
.IP
.nf
\f[C]
{ok,Size,{Type,Unit,Sign,Endian}} |
{error,Error}.
\f[R]
.fi
.PP
Parse a bitspec and return the data.
Unmentioned fields get the value `default'.
.PP
\f[B]get_bitspecs(Specs) ->\f[R]
.IP
.nf
\f[C]
{ok,Size,{Type,Unit,Sign,Endian}} |
{error,Error}.
\f[R]
.fi
.PP
Parse a bitspec, apply defaults and return the data.
Unmentioned fields get the value `default'.
.SH ERROR INFORMATION
.PP
The following error values are returned:
.PP
\f[B]{undefined_bittype,Type}\f[R]
.PP
\f[B]bittype_unit\f[R]
.SH AUTHORS
Robert Virding.