Enum msgpacker::Message

source · [−]

pub enum Message {
    Integer(Integer),
    Nil,
    Boolean(bool),
    Float(Float),
    String(String),
    Bin(Vec<u8>),
    Array(Vec<Self>),
    Map(Vec<MapEntry>),
    Extension(Extension),
}

Expand description

MessagePack protocol type

specs

Variants

`Integer(Integer)`

Integer 64-bit representation

`Nil`

Null value

`Boolean(bool)`

Boolean value

`Float(Float)`

Float representation

`String(String)`

String value

`Bin(Vec<u8>)`

Binary value

`Array(Vec<Self>)`

Set of messages

`Map(Vec<MapEntry>)`

Map message -> message

`Extension(Extension)`

Custom extension

Implementations

source

impl Message

source

pub fn to_ref(&self) -> MessageRef<'_>

Cast this message to a reference variant bound to the same lifetime.

The values cheaper than a pointer will be copied.

source

pub const fn as_integer(&self) -> Option<Integer>

Return the attribute, if matched

source

pub const fn as_boolean(&self) -> Option<bool>

Return the attribute, if matched

source

pub const fn as_float(&self) -> Option<Float>

Return the attribute, if matched

source

pub fn as_string(&self) -> Option<&str>

Return the attribute, if matched

source

pub fn as_bin(&self) -> Option<&[u8]>

Return the attribute, if matched

source

pub fn as_array(&self) -> Option<&[Message]>

Return the attribute, if matched

source

pub fn as_map(&self) -> Option<&[MapEntry]>

Return the attribute, if matched

source

pub fn as_extension(&self) -> Option<&Extension>

Return the attribute, if matched

source

pub const fn is_nil(&self) -> bool

Return true if the message is nil

source

pub fn integer_unsigned<T>(n: T) -> Self where
T: Into<u64>,

Create a new unsigned interger

source

pub fn integer_signed<T>(n: T) -> Self where
T: Into<i64>,

Create a new signed interger

source

pub fn float32<F: Into<f32>>(f: F) -> Self

Create a new 32-bits floating point

source

pub fn float64<F: Into<f64>>(f: F) -> Self

Create a new 64-bits floating point

source

pub fn boolean<B: Into<bool>>(b: B) -> Self

Create a new boolean

source

pub const fn nil() -> Self

Create a null representation

source

pub fn string<S: ToString>(s: S) -> Self

Create a string representation

source

pub fn bin<B: Into<Vec<u8>>>(b: B) -> Self

Create a binary representation

source

pub fn array<A: Into<Vec<Self>>>(a: A) -> Self

Create a array representation

source

pub fn map<M: Into<Vec<MapEntry>>>(m: M) -> Self

Create a map representation

source

pub fn extension_fixed<const N: usize>(class: i8, data: [u8 ; N]) -> Option<Self>

Create a new extension of fixed size

source

pub fn extension_variable(class: i8, data: Vec<u8>) -> Self

Create a new extension of variable size

source

pub fn extension_timestamp(duration: Duration) -> Self

Create a new timestamp extension

source

pub fn unpack<R>(reader: &mut R) -> Result<Self> where
R: Read,

Consume the bytes required to read a new message.

Need to take R as reference until recursion resolution bug is solved: 39959

source

pub fn pack<W>(&self, writer: &mut W) -> Result<usize> where
W: Write,

Write this message as bytes into the writer, moving the cursor to the end of the written region

Need to take W as reference until recursion resolution bug is solved: 39959

Trait Implementations

source

impl Clone for Message

source

fn clone(&self) -> Message

Returns a copy of the value. Read more

1.0.0 · source

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

source

impl Debug for Message

source

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

source