Enum Event 

#[non_exhaustive]
pub enum Event<'a> {
    Unsigned(u64),
    Signed(u64),
    ByteString(Cow<'a, [u8]>),
    UnknownLengthByteString,
    TextString(Cow<'a, str>),
    UnknownLengthTextString,
    Array(u64),
    UnknownLengthArray,
    Map(u64),
    UnknownLengthMap,
    UnrecognizedTag(u64),
    Bool(bool),
    Null,
    Undefined,
    Float(f64),
    Break,
}

An event encountered while decoding or encoding CBOR using a streaming extended implementation.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Unsigned(u64)

An unsigned integer.

Signed(u64)

A signed integer in a slightly odd representation.

The actual value of the integer is -1 minus the provided value. Some integers that can be CBOR encoded underflow i64. Use one of the interpret_signed associated functions to resolve this.

ByteString(Cow<'a, [u8]>)

A byte string.

UnknownLengthByteString

The start of a byte string whose length is unknown.

After this event come a series of ByteString events, followed by a Break. To get the true value of the byte string, concatenate the ByteString events together.

TextString(Cow<'a, str>)

A text string.

UnknownLengthTextString

The start of a text string whose length is unknown.

After this event come a series of TextString events, followed by a Break. To get the true value of the text string, concatenate the TextString events together.

Array(u64)

The start of an array with a known length.

UnknownLengthArray

The start of an array whose length is unknown.

After this event come a series of events representing the items in the array. The array ends at the matching Break event.

Map(u64)

The start of a map with a known length.

Note that the actual number of sub-items is twice the length given. The first in each pair is a key, and the second is the value.

UnknownLengthMap

The start of a map with an unknown length.

UnrecognizedTag(u64)

Additional type information for the next CBOR item.

Bool(bool)

A boolean.

Null

The null value.

Undefined

The undefined value.

Float(f64)

A floating-point number.

Break

The end of an unknown-length item.

Implementations

impl Event<'_>

pub fn into_owned(self) -> Event<'static>

Convert this Event to an owned value.

pub fn interpret_signed(val: u64) -> i64

Interpret a Event::Signed value.

This is a convenience alias for the basic Event’s interpet_signed.

pub fn interpret_signed_checked(val: u64) -> Option<i64>

Interpret a Event::Signed value.

This is a convenience alias for the basic Event’s interpret_signed_checked.

pub fn interpret_signed_wide(val: u64) -> i128

Interpret a Event::Signed value.

This is a convenience alias for the basic Event’s interpret_signed_wide.

pub fn create_signed(val: i64) -> Event<'static>

Create a Event::Signed or Event::Unsigned value.

This is a convenience alias for the basic Event’s create_signed, except that it returns an extended Event instead.

pub fn create_signed_wide(val: i128) -> Option<Event<'static>>

Create a Event::Signed or Event::Unsigned value.

This is a convenience alias for the basic Event’s create_signed_wide, except that it returns an extended Event instead.

Trait Implementations

impl<'a> Clone for Event<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Event<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq for Event<'a>

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> StructuralPartialEq for Event<'a>