Module msgpack_unpacker

Data Types

format_type()

format_type() = jsx | jiffy | map

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:opt_record()) -> {msgpack_map(), binary()} | no_return())

msgpack_term()

msgpack_term() = [msgpack_term()] | msgpack_map() | integer() | float() | boolean() | binary() | string() | {string, string()}

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(), Options_v4::#options_v4{spec = new | old, allow_atom = none | pack, known_atoms = [atom() | binary()], unpack_str = as_binary | as_list | as_tagged_list, use_nil = boolean(), validate_string = boolean(), pack_str = from_binary | from_list | from_tagged_list | none, map_format = format_type(), map_unpack_fun = msgpack_map_unpacker(), ext_packer = msgpack:ext_packer() | undefined, ext_unpacker = msgpack:ext_unpacker() | undefined, original_list = msgpack:options()}) -> {map(), binary()} | no_return()

unpack_map_jiffy/3

unpack_map_jiffy(Bin::binary(), Len::non_neg_integer(), Options_v4::#options_v4{spec = new | old, allow_atom = none | pack, known_atoms = [atom() | binary()], unpack_str = as_binary | as_list | as_tagged_list, use_nil = boolean(), validate_string = boolean(), pack_str = from_binary | from_list | from_tagged_list | none, map_format = format_type(), map_unpack_fun = msgpack_map_unpacker(), ext_packer = msgpack:ext_packer() | undefined, ext_unpacker = msgpack:ext_unpacker() | undefined, original_list = msgpack:options()}) -> {msgpack:msgpack_map_jiffy(), binary()} | no_return()

unpack_map_jsx/3

unpack_map_jsx(Bin::binary(), Len::non_neg_integer(), Options_v4::#options_v4{spec = new | old, allow_atom = none | pack, known_atoms = [atom() | binary()], unpack_str = as_binary | as_list | as_tagged_list, use_nil = boolean(), validate_string = boolean(), pack_str = from_binary | from_list | from_tagged_list | none, map_format = format_type(), map_unpack_fun = msgpack_map_unpacker(), ext_packer = msgpack:ext_packer() | undefined, ext_unpacker = msgpack:ext_unpacker() | undefined, original_list = msgpack:options()}) -> {msgpack:msgpack_map_jsx(), binary()} | no_return()

unpack_stream/2

unpack_stream(Bin::binary(), Options_v4::#options_v4{spec = new | old, allow_atom = none | pack, known_atoms = [atom() | binary()], unpack_str = as_binary | as_list | as_tagged_list, use_nil = boolean(), validate_string = boolean(), pack_str = from_binary | from_list | from_tagged_list | none, map_format = format_type(), map_unpack_fun = msgpack_map_unpacker(), ext_packer = msgpack:ext_packer() | undefined, ext_unpacker = msgpack:ext_unpacker() | undefined, original_list = msgpack:options()}) -> {msgpack:object(), binary()} | {error, any()} | no_return()


Generated by EDoc