Struct InvReqBuilder 

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

Streaming builder for an InvokeRequestMessage. Type-state-tagged so the compiler enforces in-order field writes.

All three top-level fields (SuppressResponse, TimedRequest, InvokeRequests) are mandatory on the wire per Matter Core spec, and the builder always emits all three. The two booleans are optional at the API level though — skipping either setter causes the builder to write the field with its default value (false) before opening the next state. This matches the write_builder ergonomics and keeps the common-case ceremony to invoke_requests()? only. The CmdData entries inside the array have an optional CommandRef, also implicitly skippable.

Field-state values:

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

Implementations

impl<P> InvReqBuilder<P>

where P: TLVBuilderParent,

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

Begin a new InvokeRequestMessage — opens a struct at the given tag. For top-level use (the usual case) pass &TLVTag::Anonymous.

impl<P> InvReqBuilder<P>

where P: TLVBuilderParent,

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

Write the SuppressResponse field. Omitting this call is equivalent to suppress_response(false) (i.e. the typical case — most clients want a response); the builder emits the default automatically when timed_request or invoke_requests is called from state 0. Set to true only for fire-and-forget commands.

impl<P> InvReqBuilder<P>

where P: TLVBuilderParent,

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

Write the TimedRequest field, implicitly emitting SuppressResponse(false) first (the common-case default).

impl<P> InvReqBuilder<P, 1>

where P: TLVBuilderParent,

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

Write the TimedRequest field. Omitting this call is equivalent to timed_request(false); the builder emits the default automatically when invoke_requests is called from state 1. Set to true only when the surrounding flow sent a TimedRequest IM message first (some commands like ACL writes require this).

impl<P> InvReqBuilder<P>

where P: TLVBuilderParent,

pub fn invoke_requests( self, ) -> Result<CmdDataArrayBuilder<InvReqBuilder<P, 3>>, Error>

Open the InvokeRequests array, implicitly emitting SuppressResponse(false) and TimedRequest(false) first.

impl<P> InvReqBuilder<P, 1>

where P: TLVBuilderParent,

pub fn invoke_requests( self, ) -> Result<CmdDataArrayBuilder<InvReqBuilder<P, 3>>, Error>

Open the InvokeRequests array, implicitly emitting TimedRequest(false) first.

impl<P> InvReqBuilder<P, 2>

where P: TLVBuilderParent,

pub fn invoke_requests( self, ) -> Result<CmdDataArrayBuilder<InvReqBuilder<P, 3>>, Error>

Open the InvokeRequests array. Each .push() starts one CmdDataBuilder; close with .end() to return to the message builder.

impl<P> InvReqBuilder<P, 3>

where P: TLVBuilderParent,

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

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

where P: TLVBuilderParent,

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

where P: TLVBuilderParent,

type Write = <P as TLVBuilderParent>::Write

The type of the writer.

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

Return a mutable reference to the writer.