Struct WriteReqBuilder 

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

Streaming builder for a WriteRequestMessage. Type-state-tagged so the compiler enforces in-order field writes. Optional fields are implicitly skipped by simply not calling their setter — later-field setters are available on all earlier states.

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

• 0: nothing written yet
• 1: past SuppressResponse (written or skipped)
• 2: past TimedRequest
• 3: past WriteRequests array (closed)
• 4: past MoreChunkedMessages
• 5: past InteractionModelRevision (auto-injected at default value IM_REVISION by end() if the optional setter wasn’t called)

In practice almost every call is WriteReqBuilder::new(p)? .write_requests()? … .end()? — SuppressResponse and MoreChunkedMessages default to absent (= false on the wire), TimedRequest is only set when issuing a timed write.

Implementations

impl<P> WriteReqBuilder<P>

where P: TLVBuilderParent,

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

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

impl<P> WriteReqBuilder<P>

where P: TLVBuilderParent,

pub fn suppress_response( self, value: bool, ) -> Result<WriteReqBuilder<P, 1>, Error>

Write the optional SuppressResponse field. Omit (don’t call) to leave the field absent on the wire.

impl<P> WriteReqBuilder<P>

where P: TLVBuilderParent,

pub fn timed_request(self, value: bool) -> Result<WriteReqBuilder<P, 2>, Error>

Write the optional TimedRequest field. Calling this from state 0 implicitly skips SuppressResponse.

impl<P> WriteReqBuilder<P, 1>

where P: TLVBuilderParent,

pub fn timed_request(self, value: bool) -> Result<WriteReqBuilder<P, 2>, Error>

Write the optional TimedRequest field.

impl<P> WriteReqBuilder<P>

where P: TLVBuilderParent,

pub fn write_requests( self, ) -> Result<AttrDataArrayBuilder<WriteReqBuilder<P, 3>>, Error>

Open the WriteRequests array. Calling from state 0 implicitly skips both SuppressResponse and TimedRequest.

impl<P> WriteReqBuilder<P, 1>

where P: TLVBuilderParent,

pub fn write_requests( self, ) -> Result<AttrDataArrayBuilder<WriteReqBuilder<P, 3>>, Error>

Open the WriteRequests array, implicitly skipping TimedRequest.

impl<P> WriteReqBuilder<P, 2>

where P: TLVBuilderParent,

pub fn write_requests( self, ) -> Result<AttrDataArrayBuilder<WriteReqBuilder<P, 3>>, Error>

Open the WriteRequests array. Each .push() on the returned builder starts one AttrData entry; close with .end() to return to the message builder.

impl<P> WriteReqBuilder<P, 3>

where P: TLVBuilderParent,

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

Write the optional MoreChunkedMessages field. Omit (don’t call — go straight to .end()) for single-chunk writes.

impl<P> WriteReqBuilder<P, 3>

where P: TLVBuilderParent,

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

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

impl<P> WriteReqBuilder<P, 3>

where P: TLVBuilderParent,

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

Write InteractionModelRevision, implicitly skipping MoreChunkedMessages. 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> WriteReqBuilder<P, 4>

where P: TLVBuilderParent,

pub fn interaction_model_revision( self, value: u8, ) -> Result<WriteReqBuilder<P, 5>, 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.

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> WriteReqBuilder<P, 5>

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 WriteReqBuilder<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 WriteReqBuilder<P>

where P: TLVBuilderParent,

fn new(parent: P, tag: &TLVTag) -> Result<WriteReqBuilder<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 WriteReqBuilder<P, F>

where P: TLVBuilderParent,

type Write = <P as TLVBuilderParent>::Write

The type of the writer.

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

Return a mutable reference to the writer.