Struct tlv_rs::TLV

pub struct TLV<Type, Length, EncodedType, Payload> {
    pub tlv_type: EncodedType,
    pub payload: Payload,
    pub _phantom: PhantomData<(Type, Length)>,
}

A TLV.

This has to be constructed with ..Default::default() as internally there exists a PhantomData. The first type parameter is the raw type of the tlv type. The second is the strongly typed tlv type, which has to implement conversions from and into the raw tlv type. The third parameter is the type of the length of the TLV. The last parameter is a constant boolean, which describes if the fields should be encoded using big endian.

Fields

tlv_type: EncodedType

payload: Payload

_phantom: PhantomData<(Type, Length)>

Implementations

impl<'a, Type: TryFromCtx<'a, Endian, Error = Error> + TryIntoCtx<Endian, Error = Error> + From<EncodedType>, Length: 'a + TryFromCtx<'a, Endian, Error = Error> + TryIntoCtx<Endian, Error = Error> + TryInto<usize> + TryFrom<usize>, EncodedType: 'a + From<Type>, Payload: TryFromCtx<'a, Error = Error> + TryIntoCtx<Error = Error> + MeasureWith<()>> TLV<Type, Length, EncodedType, Payload>

pub fn from_bytes(bytes: &'a [u8], big_endian: bool) -> Result<Self, Error>

Wrapper around scroll Pread.

pub fn into_bytes( self, buf: &mut [u8], big_endian: bool ) -> Result<usize, Error>

Serialize into the buffer.

pub fn into_bytes_capped<const N: usize>( self, big_endian: bool ) -> Result<Vec<u8, N>, Error>

Serialize into a heapless::Vec.

Trait Implementations

impl<Type: Clone, Length: Clone, EncodedType: Clone, Payload: Clone> Clone for TLV<Type, Length, EncodedType, Payload>

fn clone(&self) -> TLV<Type, Length, EncodedType, Payload>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Type: Debug, Length: Debug, EncodedType: Debug, Payload: Debug> Debug for TLV<Type, Length, EncodedType, Payload>

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

Formats the value using the given formatter.

impl<Type: Default, Length: Default, EncodedType: Default, Payload: Default> Default for TLV<Type, Length, EncodedType, Payload>

fn default() -> TLV<Type, Length, EncodedType, Payload>

Returns the “default value” for a type.

impl<Type: SizeWith, Length: SizeWith, EncodedType: From<Type>, Payload: MeasureWith<()>> MeasureWith<()> for TLV<Type, Length, EncodedType, Payload>

fn measure_with(&self, ctx: &()) -> usize

How large is Self, given the ctx?

impl<Type: PartialEq, Length: PartialEq, EncodedType: PartialEq, Payload: PartialEq> PartialEq for TLV<Type, Length, EncodedType, Payload>

fn eq(&self, other: &TLV<Type, Length, EncodedType, Payload>) -> bool

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

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

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

impl<'a, Type: TryFromCtx<'a, Endian, Error = Error>, Length: TryFromCtx<'a, Endian, Error = Error> + TryInto<usize>, EncodedType: 'a + From<Type>, Payload: TryFromCtx<'a, Error = Error>> TryFromCtx<'a, Endian> for TLV<Type, Length, EncodedType, Payload>

type Error = Error

fn try_from_ctx( from: &'a [u8], ctx: Endian ) -> Result<(Self, usize), Self::Error>

impl<Type: TryIntoCtx<Endian, Error = Error>, Length: TryIntoCtx<Endian, Error = Error> + TryFrom<usize>, EncodedType: Into<Type>, Payload: TryIntoCtx<Error = Error> + MeasureWith<()>> TryIntoCtx<Endian> for TLV<Type, Length, EncodedType, Payload>

type Error = Error

fn try_into_ctx(self, buf: &mut [u8], ctx: Endian) -> Result<usize, Self::Error>

impl<Type: Eq, Length: Eq, EncodedType: Eq, Payload: Eq> Eq for TLV<Type, Length, EncodedType, Payload>

impl<Type, Length, EncodedType, Payload> StructuralEq for TLV<Type, Length, EncodedType, Payload>

impl<Type, Length, EncodedType, Payload> StructuralPartialEq for TLV<Type, Length, EncodedType, Payload>