home | help
lfe_bits(3)							     lfe_bits(3)

NAME
     lfe_bits - Lisp Flavoured Erlang (LFE) common binary functions

SYNOPSIS
     This module contains a collection of library functions for for handling bi-
     naries.  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 `de-
     fault'.

     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

AUTHORS
     Robert Virding.

				    2011-2016			     lfe_bits(3)

home | help