Enum msgpacker::MessageRef

pub enum MessageRef<'a> {
    Integer(Integer),
    Nil,
    Boolean(bool),
    Float(Float),
    String(&'a str),
    Bin(&'a [u8]),
    Array(Vec<Self>),
    Map(Vec<MapEntryRef<'a>>),
    Extension(ExtensionRef<'a>),
}

MessagePack protocol type used as reference.

The lifetime of this struct must be bound to the unpack provider. If the underlying data of the reader is dropped while this struct is still in use, some undefined behavior might happen.

specs

Variants

Integer(Integer)

Integer 64-bit representation

Tuple Fields of Integer

0: Integer

Nil

Null value

Boolean(bool)

Boolean value

Tuple Fields of Boolean

0: bool

Float(Float)

Float representation

Tuple Fields of Float

0: Float

String(&'a str)

String value

Tuple Fields of String

0: &'a str

Bin(&'a [u8])

Binary value

Tuple Fields of Bin

0: &'a [u8]

Array(Vec<Self>)

Set of messages

Tuple Fields of Array

0: Vec<Self>

Map(Vec<MapEntryRef<'a>>)

Map message -> message

Tuple Fields of Map

0: Vec<MapEntryRef<'a>>

Extension(ExtensionRef<'a>)

Custom extension

Tuple Fields of Extension

0: ExtensionRef<'a>

Implementations

impl<'a> MessageRef<'a>

pub unsafe fn into_owned(self) -> Message

Safety

The unsafety of this function reflects ExtensionRef::into_owned. If its safety criteria is met, then this function is safe.

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

Return the attribute, if matched

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

Return the attribute, if matched

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

Return the attribute, if matched

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

Return the attribute, if matched

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

Return the attribute, if matched

pub fn as_array(&self) -> Option<&[MessageRef<'_>]>

Return the attribute, if matched

pub fn as_map(&self) -> Option<&[MapEntryRef<'_>]>

Return the attribute, if matched

pub fn as_extension(&self) -> Option<&ExtensionRef<'_>>

Return the attribute, if matched

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

Consume the bytes required to read a new message reference.

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

Safety

The reader must not drop the underlying bytes before 'a expires.

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

impl<'a> Clone for MessageRef<'a>

fn clone(&self) -> MessageRef<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for MessageRef<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq<MessageRef<'a>> for MessageRef<'a>

fn eq(&self, other: &MessageRef<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &MessageRef<'a>) -> bool

This method tests for !=.

impl<'a> StructuralPartialEq for MessageRef<'a>