Skip to main content

AttrPathBuilder

rs_matter_stack::matter::im::encoding

Struct AttrPathBuilder 

Source 
pub struct AttrPathBuilder<P, const F: usize = 0> { /* private fields */ }
Expand description

Streaming builder for one AttrPath (AttributePathIB) entry.

Field-state values:

  • 0: nothing written yet
  • 1: past Node
  • 2: past Endpoint
  • 3: past Cluster
  • 4: past Attribute
  • 5: past ListIndex

Every field is optional — wildcards are common on the read side (e.g. “all attributes of cluster X on endpoint 1” omits Attribute; “every endpoint that has cluster X” omits both Endpoint and Attribute). Each setter advances directly to its own state; later-field setters on earlier states implicitly skip the ones in between.

Implementations§

Source§

impl<P> AttrPathBuilder<P>
where P: TLVBuilderParent,

Source

pub fn new(p: P, tag: &TLVTag) -> Result<AttrPathBuilder<P>, Error>

Begin a new AttrPath entry — opens a TLV list at the given tag. Use &TLVTag::Anonymous when pushed into an AttributeRequests array (the typical case).

Source§

impl<P> AttrPathBuilder<P>
where P: TLVBuilderParent,

Source

pub fn node(self, value: u64) -> Result<AttrPathBuilder<P, 1>, Error>

Write the optional Node field. Rarely used on writes/reads to “self” — exists for proxied reads against other nodes.

Source§

impl<P> AttrPathBuilder<P>
where P: TLVBuilderParent,

Source

pub fn endpoint(self, value: u16) -> Result<AttrPathBuilder<P, 2>, Error>

Write the optional Endpoint field, implicitly skipping Node. Omit (call .cluster(...) instead) for a wildcard-endpoint read.

Source§

impl<P> AttrPathBuilder<P, 1>
where P: TLVBuilderParent,

Source

pub fn endpoint(self, value: u16) -> Result<AttrPathBuilder<P, 2>, Error>

Source§

impl<P> AttrPathBuilder<P>
where P: TLVBuilderParent,

Source

pub fn cluster(self, value: u32) -> Result<AttrPathBuilder<P, 3>, Error>

Source§

impl<P> AttrPathBuilder<P, 1>
where P: TLVBuilderParent,

Source

pub fn cluster(self, value: u32) -> Result<AttrPathBuilder<P, 3>, Error>

Source§

impl<P> AttrPathBuilder<P, 2>
where P: TLVBuilderParent,

Source

pub fn cluster(self, value: u32) -> Result<AttrPathBuilder<P, 3>, Error>

Source§

impl<P> AttrPathBuilder<P>
where P: TLVBuilderParent,

Source

pub fn attr(self, value: u32) -> Result<AttrPathBuilder<P, 4>, Error>

Source§

impl<P> AttrPathBuilder<P, 1>
where P: TLVBuilderParent,

Source

pub fn attr(self, value: u32) -> Result<AttrPathBuilder<P, 4>, Error>

Source§

impl<P> AttrPathBuilder<P, 2>
where P: TLVBuilderParent,

Source

pub fn attr(self, value: u32) -> Result<AttrPathBuilder<P, 4>, Error>

Source§

impl<P> AttrPathBuilder<P, 3>
where P: TLVBuilderParent,

Source

pub fn attr(self, value: u32) -> Result<AttrPathBuilder<P, 4>, Error>

Source§

impl<P> AttrPathBuilder<P, 4>
where P: TLVBuilderParent,

Source

pub fn list_index( self, value: Option<u16>, ) -> Result<AttrPathBuilder<P, 5>, Error>

Write the optional ListIndex field — used to read a specific index within a list-typed attribute.

Source§

impl<P> AttrPathBuilder<P>
where P: TLVBuilderParent,

Source

pub fn end(self) -> Result<P, Error>

Source§

impl<P> AttrPathBuilder<P, 1>
where P: TLVBuilderParent,

Source

pub fn end(self) -> Result<P, Error>

Source§

impl<P> AttrPathBuilder<P, 2>
where P: TLVBuilderParent,

Source

pub fn end(self) -> Result<P, Error>

Source§

impl<P> AttrPathBuilder<P, 3>
where P: TLVBuilderParent,

Source

pub fn end(self) -> Result<P, Error>

Source§

impl<P> AttrPathBuilder<P, 4>
where P: TLVBuilderParent,

Source

pub fn end(self) -> Result<P, Error>

Source§

impl<P> AttrPathBuilder<P, 5>
where P: TLVBuilderParent,

Source

pub fn end(self) -> Result<P, Error>

Close the AttrPath list and return the array builder so the caller can .push() another entry or .end() the array.

Trait Implementations§

Source§

impl<P, const F: usize> Debug for AttrPathBuilder<P, F>
where P: Debug,

Source§

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

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

impl<P> TLVBuilder<P> for AttrPathBuilder<P>
where P: TLVBuilderParent,

Source§

fn new(parent: P, tag: &TLVTag) -> Result<AttrPathBuilder<P>, Error>

Create a new TLV builder for the given parent and tag.
Source§

fn unchecked_into_parent(self) -> P

Convert itself into a writer. Read more
Source§

fn with<F>(self, f: F) -> Result<P, Error>
where F: FnOnce(Self) -> Result<P, Error>,

Call a closure with the builder and return the result.
Source§

impl<P, const F: usize> TLVBuilderParent for AttrPathBuilder<P, F>
where P: TLVBuilderParent,

Source§

type Write = <P as TLVBuilderParent>::Write

The type of the writer.
Source§

fn writer(&mut self) -> &mut <AttrPathBuilder<P, F> as TLVBuilderParent>::Write

Return a mutable reference to the writer.

Auto Trait Implementations§

§

impl<P, const F: usize> Freeze for AttrPathBuilder<P, F>
where P: Freeze,

§

impl<P, const F: usize> RefUnwindSafe for AttrPathBuilder<P, F>
where P: RefUnwindSafe,

§

impl<P, const F: usize> Send for AttrPathBuilder<P, F>
where P: Send,

§

impl<P, const F: usize> Sync for AttrPathBuilder<P, F>
where P: Sync,

§

impl<P, const F: usize> Unpin for AttrPathBuilder<P, F>
where P: Unpin,

§

impl<P, const F: usize> UnsafeUnpin for AttrPathBuilder<P, F>
where P: UnsafeUnpin,

§

impl<P, const F: usize> UnwindSafe for AttrPathBuilder<P, F>
where P: UnwindSafe,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, E> Init<T, E> for T

Source§

unsafe fn __init(self, slot: *mut T) -> Result<(), E>

Initializes slot. Read more
Source§

fn chain<F>(self, f: F) -> ChainInit<Self, F, T, E>
where F: FnOnce(&mut T) -> Result<(), E>,

First initializes the value using self then calls the function f with the initialized value. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T, I> IntoFallibleInit<T> for I
where I: Init<T>,

Source§

fn into_fallible<E>(self) -> impl Init<T, E>

Convert the infallible initializer to a fallible one.
Source§

impl<Source, Target> OctetsInto<Target> for Source
where Target: OctetsFrom<Source>,

Source§

type Error = <Target as OctetsFrom<Source>>::Error

Source§

fn try_octets_into( self, ) -> Result<Target, <Source as OctetsInto<Target>>::Error>

Performs the conversion.
Source§

fn octets_into(self) -> Target
where Self::Error: Into<Infallible>,

Performs an infallible conversion.
Source§

impl<T, E> PinInit<T, E> for T

Source§

unsafe fn __pinned_init(self, slot: *mut T) -> Result<(), E>

Initializes slot. Read more
Source§

fn pin_chain<F>(self, f: F) -> ChainPinInit<Self, F, T, E>
where F: FnOnce(Pin<&mut T>) -> Result<(), E>,

First initializes the value using self then calls the function f with the initialized value. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V