Struct ReadReqBuilder 

pub struct ReadReqBuilder<P, const F: usize = 0> { /* private fields */ }

Streaming builder for a ReadRequestMessage. Type-state-tagged so the compiler enforces in-order field writes; optional fields are implicitly skipped by not calling their setter.

Field-state values (state after each named field has been written or implicitly skipped):

• 0: nothing written yet
• 1: past AttributeRequests
• 2: past EventRequests
• 3: past EventFilters
• 4: past FabricFiltered (mandatory; no implicit-skip path from state 0/1/2/3 to here)
• 5: past DataVersionFilters
• 6: past InteractionModelRevision (auto-injected at default value IM_REVISION by end() if the optional setter wasn’t called)

Implementations

impl<P> ReadReqBuilder<P>

where P: TLVBuilderParent,

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

Begin a new ReadRequestMessage — opens a struct at the given tag on the parent’s writer. For top-level use (the usual case) pass &TLVTag::Anonymous.

impl<P> ReadReqBuilder<P>

where P: TLVBuilderParent,

pub fn attr_requests( self, ) -> Result<AttrPathArrayBuilder<ReadReqBuilder<P, 1>>, Error>

Open the optional AttributeRequests array. Each .push() yields an AttrPathBuilder; close with .end() to advance to the next message field.

pub fn attr_requests_from( self, paths: &[AttrPath], ) -> Result<ReadReqBuilder<P, 1>, Error>

Write AttributeRequests from a pre-built slice. Convenience for callers that already have an &[AttrPath] on hand.

impl<P> ReadReqBuilder<P>

where P: TLVBuilderParent,

pub fn event_requests_from( self, paths: &[EventPath], ) -> Result<ReadReqBuilder<P, 2>, Error>

Write EventRequests from a pre-built slice, implicitly skipping AttributeRequests.

impl<P> ReadReqBuilder<P, 1>

where P: TLVBuilderParent,

pub fn event_requests_from( self, paths: &[EventPath], ) -> Result<ReadReqBuilder<P, 2>, Error>

Write EventRequests from a pre-built slice. A streaming sub-builder for EventPath is on the to-do list for when an MCU client actually subscribes to events directly.

impl<P> ReadReqBuilder<P>

where P: TLVBuilderParent,

pub fn event_filters_from( self, filters: &[EventFilter], ) -> Result<ReadReqBuilder<P, 3>, Error>

impl<P> ReadReqBuilder<P, 1>

where P: TLVBuilderParent,

pub fn event_filters_from( self, filters: &[EventFilter], ) -> Result<ReadReqBuilder<P, 3>, Error>

impl<P> ReadReqBuilder<P, 2>

where P: TLVBuilderParent,

pub fn event_filters_from( self, filters: &[EventFilter], ) -> Result<ReadReqBuilder<P, 3>, Error>

Write EventFilters from a pre-built slice.

impl<P> ReadReqBuilder<P>

where P: TLVBuilderParent,

pub fn fabric_filtered(self, value: bool) -> Result<ReadReqBuilder<P, 4>, Error>

Write the mandatory FabricFiltered field, implicitly skipping AttributeRequests, EventRequests, and EventFilters.

impl<P> ReadReqBuilder<P, 1>

where P: TLVBuilderParent,

pub fn fabric_filtered(self, value: bool) -> Result<ReadReqBuilder<P, 4>, Error>

impl<P> ReadReqBuilder<P, 2>

where P: TLVBuilderParent,

pub fn fabric_filtered(self, value: bool) -> Result<ReadReqBuilder<P, 4>, Error>

impl<P> ReadReqBuilder<P, 3>

where P: TLVBuilderParent,

pub fn fabric_filtered(self, value: bool) -> Result<ReadReqBuilder<P, 4>, Error>

Write the mandatory FabricFiltered field. true constrains reads of fabric-scoped attributes to the accessing fabric; false returns entries for every fabric the accessor has access to.

impl<P> ReadReqBuilder<P, 4>

where P: TLVBuilderParent,

pub fn dataver_filters_from( self, filters: &[DataVersionFilter], ) -> Result<ReadReqBuilder<P, 5>, Error>

Write DataVersionFilters from a pre-built slice. Used by caching clients to avoid re-reading attributes that haven’t changed since the last data version they observed.

impl<P> ReadReqBuilder<P, 4>

where P: TLVBuilderParent,

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

Close the message struct, implicitly skipping DataVersionFilters. Returns the parent.

impl<P> ReadReqBuilder<P, 4>

where P: TLVBuilderParent,

pub fn interaction_model_revision( self, value: u8, ) -> Result<ReadReqBuilder<P, 6>, Error>

Write InteractionModelRevision, implicitly skipping DataVersionFilters. This is a typestate skip-shim mirroring the pattern PR #447 established for SuppressResponse / TimedRequest on InvReqBuilder: callers who don’t populate the optional preceding field can advance straight to setting (or auto-injecting) InteractionModelRevision without an explicit no-op transition.

impl<P> ReadReqBuilder<P, 5>

where P: TLVBuilderParent,

pub fn interaction_model_revision( self, value: u8, ) -> Result<ReadReqBuilder<P, 6>, Error>

Write the mandatory-on-the-wire InteractionModelRevision field (Matter Core: value is 13 since Matter 1.3, unchanged in 1.4 and 1.5). Optional at the API level — omit and end() injects IM_REVISION automatically. Set explicitly only when speaking a non-default revision is required (e.g. interop testing against a peer pinned to an older revision).

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

Close the message struct, auto-injecting InteractionModelRevision at its default value IM_REVISION. Returns the parent.

impl<P> ReadReqBuilder<P, 6>

where P: TLVBuilderParent,

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

Close the message struct and return the parent.

Trait Implementations

impl<P, const F: usize> Debug for ReadReqBuilder<P, F>

where P: Debug,

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

Formats the value using the given formatter.

impl<P> TLVBuilder<P> for ReadReqBuilder<P>

where P: TLVBuilderParent,

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

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

fn unchecked_into_parent(self) -> P

Convert itself into a writer.

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.

impl<P, const F: usize> TLVBuilderParent for ReadReqBuilder<P, F>

where P: TLVBuilderParent,

type Write = <P as TLVBuilderParent>::Write

The type of the writer.

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

Return a mutable reference to the writer.