FixedExtension

Struct FixedExtension 

Source
pub struct FixedExtension<const N: usize> {
    pub type: i8,
    /* private fields */
}
Expand description

A fixed-capacity container for extension payloads of up to N bytes.

This type name refers to the fixed-size backing buffer, not the MessagePack header kind. The actual header used at encode-time depends on the current payload length:

  • len == 1, 2, 4, 8, 16FixExtN
  • otherwise (0..=255, 256..=65535, 65536..=u32::MAX) → Ext8/16/32

Fields§

§type: i8

Application‑defined extension type code.

Implementations§

Source§

impl<const N: usize> FixedExtension<N>

Source

pub fn new(type: i8, data: &[u8]) -> Option<Self>

Construct from a slice whose length must be <= N.

The chosen MessagePack format when encoding still follows the rules described in the type-level documentation above.

Source

pub fn new_fixed(type: i8, data: [u8; N]) -> Self

Construct with an exact N-byte payload.

Note: Even when constructed with a fixed-size buffer, the encoder will emit FixExtN only if N is one of {1, 2, 4, 8, 16}. For any other N, the encoder uses Ext8/16/32 as appropriate.

Source

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

Borrow as ExtensionRef for encoding.

Source

pub fn len(&self) -> usize

Current payload length in bytes.

Source

pub fn is_empty(&self) -> bool

Returns true if the payload is empty.

Source

pub fn data(&self) -> &[u8]

Borrow the payload slice.

Trait Implementations§

Source§

impl<const N: usize> Clone for FixedExtension<N>

Source§

fn clone(&self) -> FixedExtension<N>

Returns a duplicate 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<const N: usize> Debug for FixedExtension<N>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a, const N: usize> Decode<'a> for FixedExtension<N>

Source§

type Value = FixedExtension<N>

The materialised value type.
Source§

fn decode(buf: &'a [u8]) -> Result<(Self::Value, &'a [u8]), Error>

Decode a value from the front of buf, returning the value and the remaining slice.
Source§

fn decode_with_format( format: Format, buf: &'a [u8], ) -> Result<(Self::Value, &'a [u8]), Error>

Decode a value assuming the leading MessagePack format has already been read by the caller. Implementations must validate that format is appropriate for the type and return an error otherwise.
Source§

impl<const N: usize, W: IoWrite> Encode<W> for FixedExtension<N>

Source§

fn encode(&self, writer: &mut W) -> Result<usize, Error<W::Error>>

Encode this value to MessagePack and write bytes to writer.
Source§

impl<const N: usize> Ord for FixedExtension<N>

Source§

fn cmp(&self, other: &FixedExtension<N>) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl<const N: usize> PartialEq for FixedExtension<N>

Source§

fn eq(&self, other: &FixedExtension<N>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl<const N: usize> PartialOrd for FixedExtension<N>

Source§

fn partial_cmp(&self, other: &FixedExtension<N>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl<const N: usize> Eq for FixedExtension<N>

Source§

impl<const N: usize> StructuralPartialEq for FixedExtension<N>

Auto Trait Implementations§

§

impl<const N: usize> Freeze for FixedExtension<N>

§

impl<const N: usize> RefUnwindSafe for FixedExtension<N>

§

impl<const N: usize> Send for FixedExtension<N>

§

impl<const N: usize> Sync for FixedExtension<N>

§

impl<const N: usize> Unpin for FixedExtension<N>

§

impl<const N: usize> UnwindSafe for FixedExtension<N>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.