MessagePackDecoder¶
Implements low-level decoding from the MessagePack serialization format.
You should be familiar with how MessagePack encodes messages if you use this
API directly. There are very few guardrails preventing you from incorrectly
decoding documents. This is particularly true when using the array and
map format family encoding methods.
primitive val MessagePackDecoder
Constructors¶
create¶
new val create()
: MessagePackDecoder val^
Returns¶
- MessagePackDecoder val^
Public Functions¶
nil¶
Returns nothing. Throws an error if the next byte isn't a MessagePack nil.
fun box nil(
b: Reader ref)
: None val ?
Parameters¶
- b: Reader ref
Returns¶
- None val ?
bool¶
fun box bool(
b: Reader ref)
: Bool val ?
Parameters¶
- b: Reader ref
Returns¶
- Bool val ?
positive_fixint¶
fun box positive_fixint(
b: Reader ref)
: U8 val ?
Parameters¶
- b: Reader ref
Returns¶
- U8 val ?
negative_fixint¶
fun box negative_fixint(
b: Reader ref)
: I8 val ?
Parameters¶
- b: Reader ref
Returns¶
- I8 val ?
u8¶
fun box u8(
b: Reader ref)
: U8 val ?
Parameters¶
- b: Reader ref
Returns¶
- U8 val ?
u16¶
fun box u16(
b: Reader ref)
: U16 val ?
Parameters¶
- b: Reader ref
Returns¶
- U16 val ?
u32¶
fun box u32(
b: Reader ref)
: U32 val ?
Parameters¶
- b: Reader ref
Returns¶
- U32 val ?
u64¶
fun box u64(
b: Reader ref)
: U64 val ?
Parameters¶
- b: Reader ref
Returns¶
- U64 val ?
i8¶
fun box i8(
b: Reader ref)
: I8 val ?
Parameters¶
- b: Reader ref
Returns¶
- I8 val ?
i16¶
fun box i16(
b: Reader ref)
: I16 val ?
Parameters¶
- b: Reader ref
Returns¶
- I16 val ?
i32¶
fun box i32(
b: Reader ref)
: I32 val ?
Parameters¶
- b: Reader ref
Returns¶
- I32 val ?
i64¶
fun box i64(
b: Reader ref)
: I64 val ?
Parameters¶
- b: Reader ref
Returns¶
- I64 val ?
f32¶
fun box f32(
b: Reader ref)
: F32 val ?
Parameters¶
- b: Reader ref
Returns¶
- F32 val ?
f64¶
fun box f64(
b: Reader ref)
: F64 val ?
Parameters¶
- b: Reader ref
Returns¶
- F64 val ?
fixstr¶
fun box fixstr(
b: Reader ref)
: String iso^ ?
Parameters¶
- b: Reader ref
Returns¶
- String iso^ ?
str¶
fun box str(
b: Reader ref)
: String iso^ ?
Parameters¶
- b: Reader ref
Returns¶
- String iso^ ?
byte_array¶
fun box byte_array(
b: Reader ref)
: Array[U8 val] iso^ ?
Parameters¶
- b: Reader ref
Returns¶
fixarray¶
Reads a header for a MessgePack "fixarray". This only reads the header. The number of array items returned by this method needs to be read via other methods after this is called.
fun box fixarray(
b: Reader ref)
: U8 val ?
Parameters¶
- b: Reader ref
Returns¶
- U8 val ?
array_16¶
Reads a header for a MessgePack "array_16". This only reads the header. The number of array items returned by this method needs to be read via other methods after this is called.
fun box array_16(
b: Reader ref)
: U16 val ?
Parameters¶
- b: Reader ref
Returns¶
- U16 val ?
array_32¶
Reads a header for a MessgePack "array_32". This only reads the header. The number of array items returned by this method needs to be read via other methods after this is called.
fun box array_32(
b: Reader ref)
: U32 val ?
Parameters¶
- b: Reader ref
Returns¶
- U32 val ?
fixmap¶
Reads a header for a MessgePack "fixmap". This only reads the header. The number of map items returned by this method needs to be read via other methods after this is called.
fun box fixmap(
b: Reader ref)
: U8 val ?
Parameters¶
- b: Reader ref
Returns¶
- U8 val ?
map_16¶
Reads a header for a MessgePack "map_16". This only reads the header. The number of map items returned by this method needs to be read via other methods after this is called.
fun box map_16(
b: Reader ref)
: U16 val ?
Parameters¶
- b: Reader ref
Returns¶
- U16 val ?
map_32¶
Reads a header for a MessgePack "map_32". This only reads the header. The number of map items returned by this method needs to be read via other methods after this is called.
fun box map_32(
b: Reader ref)
: U32 val ?
Parameters¶
- b: Reader ref
Returns¶
- U32 val ?
ext¶
Allows for the reading of user supplied extensions to the MessagePack format.
fixext * types return a tuple representing:
(user supplied type indentifier, data byte array)
fun box ext(
b: Reader ref)
: (U8 val , Array[U8 val] val) ?
Parameters¶
- b: Reader ref
Returns¶
timestamp¶
fun box timestamp(
b: Reader ref)
: (I64 val , I64 val) ?
Parameters¶
- b: Reader ref
Returns¶
eq¶
fun box eq(
that: MessagePackDecoder val)
: Bool val
Parameters¶
- that: MessagePackDecoder val
Returns¶
- Bool val
ne¶
fun box ne(
that: MessagePackDecoder val)
: Bool val
Parameters¶
- that: MessagePackDecoder val
Returns¶
- Bool val