Struct LengthPrefix

pub struct LengthPrefix<Encodable, Length, Error> { /* private fields */ }

Encodes a length prefixed value (TLV).

Examples

use encode::Encodable;
use encode::combinators::LengthPrefix;
use encode::combinators::FromError;
use core::num::TryFromIntError;

let mut buf = Vec::new();
LengthPrefix::<_, u8, TryFromIntError>::new("hello").encode(&mut buf).unwrap();
assert_eq!(&buf, b"\x05hello", "Using a single byte to indicate the length of the string");

Implementations

impl<Encodable, Length, Error> LengthPrefix<Encodable, Length, Error>

pub const fn new(encodable: Encodable) -> Self

Creates a new TLV combinator.

Examples found in repository

examples/bson.rs (line 203)

    fn encode(&self, encoder: &mut Encoder) -> Result<(), Self::Error> {
        LengthPrefix::<_, LE<i32>, BsonError>::new((self.0.as_ref(), 0u8)).encode(encoder)?;
        Ok(())
    }

pub fn into_inner(self) -> Encodable

Consumes the combinator and returns the inner encodable.

Trait Implementations

impl<Encodable, Length, Error> AsRef<Encodable> for LengthPrefix<Encodable, Length, Error>

fn as_ref(&self) -> &Encodable

Converts this type into a shared reference of the (usually inferred) input type.

impl<Encodable, Length, Error> Borrow<Encodable> for LengthPrefix<Encodable, Length, Error>

fn borrow(&self) -> &Encodable

Immutably borrows from an owned value.

impl<Encodable, Length, Error> Clone for LengthPrefix<Encodable, Length, Error>

where Encodable: Clone,

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Encodable, Length, Error> Debug for LengthPrefix<Encodable, Length, Error>

where Encodable: Debug,

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

Formats the value using the given formatter.

impl<Encodable, Length, Error> Default for LengthPrefix<Encodable, Length, Error>

where Encodable: Default,

fn default() -> Self

Returns the “default value” for a type.

impl<Encodable, Length, Error> Deref for LengthPrefix<Encodable, Length, Error>

type Target = Encodable

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<Encodable, Length, Encoder, Error> Encodable<Encoder> for LengthPrefix<Encodable, Length, Error>

where Encoder: BaseEncoder, Encodable: Encodable<Encoder> + EncodableSize, Length: Encodable<Encoder> + TryFrom<usize>, Error: From<<Length as Encodable<Encoder>>::Error> + From<<Length as TryFrom<usize>>::Error> + From<<Encodable as Encodable<Encoder>>::Error> + From<<Encodable as Encodable<SizeEncoder>>::Error> + From<Encoder::Error>,

type Error = Error

The error type returned by the encode method.

fn encode(&self, encoder: &mut Encoder) -> Result<(), Self::Error>

Encodes self into the given encoder.

impl<Encodable, Length, Error> From<Encodable> for LengthPrefix<Encodable, Length, Error>

fn from(value: Encodable) -> Self

Converts to this type from the input type.

impl<Encodable, Length, Error> Ord for LengthPrefix<Encodable, Length, Error>

where Encodable: Ord,

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl<Encodable, Length, Error> PartialEq for LengthPrefix<Encodable, Length, Error>

where Encodable: PartialEq,

fn eq(&self, other: &Self) -> 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<Encodable, Length, Error> PartialOrd for LengthPrefix<Encodable, Length, Error>

where Encodable: PartialOrd,

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

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<Encodable, Length, Error> Copy for LengthPrefix<Encodable, Length, Error>

where Encodable: Copy,

impl<Encodable, Length, Error> Eq for LengthPrefix<Encodable, Length, Error>

where Encodable: Eq,