Struct TLVSequence 

pub struct TLVSequence<'a>(/* private fields */);

A newtype for iterating over the TLVElement “child” instances contained in TLVElement which is a TLV container (array, struct or list). (Internally, TLVSequence might be used for other purposes, but the external contract is only the one from above.)

Just like TLVElement, TLVSequence is a newtype over a byte slice - the byte sub-slice of the parent TLVElement container where its value starts.

Unlike TLVElement, TLVSequence - as the name suggests - represents a sequence of 0, 1 or more TLVElements. The only public API of TLVSequence however is the iter method which returns a TLVContainerIter iterator over the TLVElement instances in the sequence.

Implementations

impl<'a> TLVSequence<'a>

pub fn iter(&self) -> TLVSequenceIter<'a>

Return an iterator over the TLVElement instances in this TLVSequence.

pub fn tlv_iter(&self) -> TLVSequenceTLVIter<'a>

Return an iterator over the TLV instances in this TLVSequence.

The difference with iter is that for container elements, tlv_iter will return separate TLV instances for the container start, the container elements and the container end, where if an element in the container is itself a container, the algorithm will be applied recursively to the inner container.

pub fn ctx(&self, ctx: u8) -> Result<TLVElement<'a>, Error>

A convenience utility that returns the first TLVElement in the sequence which is tagged with a context tag (TLVTag::Context) where the context ID is matching the ID passed in the ctx parameter.

If there is no TLV element tagged with a context tag with the matching ID, the method will return an error.

pub fn find_ctx(&self, ctx: u8) -> Result<TLVElement<'a>, Error>

A convenience utility that returns the first TLVElement in the sequence which is tagged with a context tag (TLVTag::Context) where the context ID is matching the ID passed in the ctx parameter.

If there is no TLV element tagged with a context tag with the matching ID, the method will return an empty TLVElement.

pub fn scan_ctx(&mut self, ctx: u8) -> Result<TLVElement<'a>, Error>

A convenience utility that returns the first TLVElement in the sequence which is tagged with a context tag (TLVTag::Context) where the context ID is equal to the ID passed in the ctx parameter.

If there is no TLV element tagged with a context tag with the matching ID, the method will return an empty TLV element.

As a side effect of calling this method, the TLVSequence instance will be updated to point to the next element after the found element, or if an element with the provided context ID does not exist, to the first element with a bigger context ID than the one we are looking for.

pub fn scan_map<F, T>(&mut self, f: F) -> Result<T, Error>

where F: FnMut(TLVElement<'a>) -> Result<Option<T>, Error>,

A convenience utility that returns scans the elements in the sequence, in-order and stops scanning once the provided mapping closure f returns a non-empty result.

As a side effect of calling this method, the TLVSequence instance will be updated to point to the next element after the one on which the provided closure returned a non-empty result.

Note that the closure must ultimately return a non-empty result - if for nothing else then for the empty element that is passed to it when the sequence is exhausted, or else the method would loop forever.

pub fn raw_value(&self) -> Result<&'a [u8], Error>

Return a raw byte sub-slice representing the TLV-encoded elements and only those elements that belong to the TLV container whose elements are represented by this TLVSequence instance.

This method is necessary, because both TLVElement instances, as well as TLVSequence instances - for optimization purposes - might be constructed during iteration on slices which are technically longer than the actual TLV-encoded data they represent.

So in case the user is need of the actual, exact raw representation of a TLV container value, this method is provided.

Trait Implementations

impl<'a> Clone for TLVSequence<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TLVSequence<'_>

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

Formats the value using the given formatter.

impl Display for TLVSequence<'_>

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

Formats the value using the given formatter.

impl<'a> Eq for TLVSequence<'a>

impl<'a> Hash for TLVSequence<'a>

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> PartialEq for TLVSequence<'a>

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

Equality operator ==.

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

Inequality operator !=.

impl<'a> StructuralPartialEq for TLVSequence<'a>