Module msgpack_unpacker

Data Types

format_type()

format_type() = jsx | jiffy | map

msgpack_ext_packer()

msgpack_ext_packer() = fun((tuple(), msgpack:options()) -> {ok, {Type::byte(), Data::binary()}} | {error, any()})

msgpack_ext_unpacker()

msgpack_ext_unpacker() = fun((byte(), binary(), msgpack:options()) -> {ok, msgpack_term()} | {error, any()}) | fun((byte(), binary()) -> {ok, msgpack_term()} | {error, any()})

msgpack_list_options()

msgpack_list_options() = [{format, format_type()} | jsx | jiffy | {allow_atom, none | pack} | {enable_str, boolean()} | {ext, {msgpack_ext_packer(), msgpack_ext_unpacker()} | module()}]

msgpack_map()

msgpack_map() = msgpack_map_jsx() | msgpack_map_jiffy() | map()

msgpack_map_jiffy()

msgpack_map_jiffy() = {[{msgpack_term(), msgpack_term()}]}

msgpack_map_jsx()

msgpack_map_jsx() = [{msgpack_term(), msgpack_term()}] | [{}]

msgpack_map_unpacker()

msgpack_map_unpacker() = fun((binary(), non_neg_integer(), msgpack_option()) -> {msgpack_map(), binary()} | no_return())

msgpack_option()

msgpack_option() = #options_v3{interface = format_type(), map_unpack_fun = msgpack_map_unpacker(), impl = erlang | nif, allow_atom = none | pack, enable_str = boolean(), ext_packer = msgpack_ext_packer() | undefined, ext_unpacker = msgpack_ext_unpacker() | undefined, original_list = msgpack_list_options()}

msgpack_term()

msgpack_term() = [msgpack_term()] | msgpack_map() | integer() | float() | boolean() | binary()

Function Index

map_unpacker/1
unpack_map/3
unpack_map_jiffy/3
unpack_map_jsx/3
unpack_stream/2

Function Details

map_unpacker/1

map_unpacker(X1) -> any()

unpack_map/3

unpack_map(Bin::binary(), Len::non_neg_integer(), Opt::msgpack_option()) -> {map(), binary()} | no_return()

unpack_map_jiffy/3

unpack_map_jiffy(Bin::binary(), Len::non_neg_integer(), Opt::msgpack_option()) -> {msgpack:msgpack_map_jiffy(), binary()} | no_return()

unpack_map_jsx/3

unpack_map_jsx(Bin::binary(), Len::non_neg_integer(), Opt::msgpack_option()) -> {msgpack:msgpack_map_jsx(), binary()} | no_return()

unpack_stream/2

unpack_stream(Bin::binary(), Opt::msgpack_option()) -> {msgpack:object(), binary()} | no_return()


Generated by EDoc, Jan 17 2019, 03:07:28.