Struct TLV 

pub struct TLV<'a> {
    pub tag: TLVTag,
    pub value: TLVValue<'a>,
}

A high-level representation of a TLV tag + value.

Amongsat other things, it is a convenient way to emit TLV byte sequences.

A TLV can be constructed programmatically, or returned from a TLVElement.

Unlike a TLVElement however, a TLV does not represent a complete container, but rather, its beginning or end.

I.e.

use rs_matter::tlv::{TLV, TLVTag, TLVValue};

let tlvs = &[
    TLV::new(TLVTag::Anonymous, TLVValue::Struct),
    TLV::new(TLVTag::Context(0), TLVValue::Utf8l("Hello, World!")),
    TLV::new(TLVTag::Anonymous, TLVValue::EndCnt),
];

let bytes_iter = tlvs.iter().flat_map(|tlv| tlv.bytes_iter());
for byte in bytes_iter {
   println!("{:02X}", byte);
}

Fields

tag: TLVTag

value: TLVValue<'a>

Implementations

impl<'a> TLV<'a>

pub const fn new(tag: TLVTag, value: TLVValue<'a>) -> TLV<'a>

Create a new TLV instance with the provided tag and value.

pub const fn i8(tag: TLVTag, value: i8) -> TLV<'a>

Create a TLV with the given tag and the provided value as an S8 TLV.

pub const fn i16(tag: TLVTag, value: i16) -> TLV<'a>

Create a TLV with the given tag and the provided value as an S8 or S16 TLV, depending on whether the value is small enough to fit in an S8 TLV.

pub const fn i32(tag: TLVTag, value: i32) -> TLV<'a>

Create a TLV with the given tag and the provided value as an S8, S16, or S32 TLV, depending on whether the value is small enough to fit in an S8 or S16 TLV.

pub const fn i64(tag: TLVTag, value: i64) -> TLV<'a>

Create a TLV with the given tag and the provided value as an S8, S16, S32, or S64 TLV, depending on whether the value is small enough to fit in an S8, S16, or S32 TLV.

pub const fn u8(tag: TLVTag, value: u8) -> TLV<'a>

Create a TLV with the given tag and the provided value as a U8 TLV.

pub const fn u16(tag: TLVTag, value: u16) -> TLV<'a>

Create a TLV with the given tag and the provided value as a U8 or U16 TLV, depending on whether the value is small enough to fit in a U8 TLV.

pub const fn u32(tag: TLVTag, value: u32) -> TLV<'a>

Create a TLV with the given tag and the provided value as a U8, U16, or U32 TLV, depending on whether the value is small enough to fit in a U8 or U16 TLV.

pub const fn u64(tag: TLVTag, value: u64) -> TLV<'a>

Create a TLV with the given tag and the provided value as a U8, U16, U32, or U64 TLV, depending on whether the value is small enough to fit in a U8, U16, or U32 TLV.

pub const fn f32(tag: TLVTag, value: f32) -> TLV<'a>

Create a TLV with the given tag and the provided value as a F32 TLV.

pub const fn f64(tag: TLVTag, value: f64) -> TLV<'a>

Create a TLV with the given tag and the provided value as a F64 TLV.

pub const fn utf8(tag: TLVTag, value: &'a str) -> TLV<'a>

Create a TLV with the given tag and the provided value as a UTF-8 TLV. The length of the string is encoded as 1, 2, 4 or 8 octets, depending on the length of the string.

pub const fn str(tag: TLVTag, value: &'a [u8]) -> TLV<'a>

Create a TLV with the given tag and the provided value as an octet string TLV. The length of the string is encoded as 1, 2, 4 or 8 octets, depending on the length of the string.

pub const fn struct(tag: TLVTag) -> TLV<'a>

Create a TLV with the given tag which will have a value of type Struct (start).

pub const fn structure(tag: TLVTag) -> TLV<'a>

Create a TLV with the given tag which will have a value of type Struct (start).

pub const fn array(tag: TLVTag) -> TLV<'a>

Create a TLV with the given tag which will have a value of type Array (start).

pub const fn list(tag: TLVTag) -> TLV<'a>

Create a TLV with the given tag which will have a value of type List (start).

pub const fn end_container() -> TLV<'a>

Create a TLV with the given tag which will have a value of type EndCnt (container end).

pub const fn null(tag: TLVTag) -> TLV<'a>

Create a TLV with the given tag which will have a value of type Null.

pub const fn bool(tag: TLVTag, value: bool) -> TLV<'a>

Create a TLV with the given tag which will have a value of type True.

pub fn into_tlv_iter(self) -> Once<Result<TLV<'a>, Error>>

Converts the TLV into an iterator with a single item - the TLV.

pub fn bytes_iter(&self) -> TLVBytesIter<'a, &TLVTag, &TLVValue<'a>>

Returns an iterator over the bytes of the TLV.

pub fn into_bytes_iter(self) -> TLVBytesIter<'a, TLVTag, TLVValue<'a>>

Converts the TLV into an iterator over its bytes.

pub fn result_into_bytes_iter( result: Result<TLV<'a>, Error>, ) -> TLVResultBytesIter<'a, TLVTag, TLVValue<'a>>

Converts the provided result into an iterator over the bytes of the TLV.

Trait Implementations

impl<'a> Clone for TLV<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for TLV<'a>

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

Formats the value using the given formatter.

impl<'a> IntoIterator for TLV<'a>

type Item = u8

The type of the elements being iterated over.

type IntoIter = TLVBytesIter<'a, TLVTag, TLVValue<'a>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <TLV<'a> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<'s, 'a> IntoIterator for &'s TLV<'a>

type Item = u8

The type of the elements being iterated over.

type IntoIter = TLVBytesIter<'a, &'s TLVTag, &'s TLVValue<'a>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'s TLV<'a> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<'a> PartialEq for TLV<'a>

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

Equality operator ==.

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

Inequality operator !=.

impl<'a> StructuralPartialEq for TLV<'a>