Struct CmdDataBuilder 

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

Streaming builder for one CmdData entry inside the InvokeRequests array.

Field-state values:

• 0: nothing written yet
• 1: past Path
• 2: past Data (struct can be closed)
• 3: past CommandRef

Implementations

impl<P> CmdDataBuilder<P>

where P: TLVBuilderParent,

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

Begin a new CmdData entry — opens a struct at the given tag. Use &TLVTag::Anonymous when pushed into an InvokeRequests array (the typical case).

impl<P> CmdDataBuilder<P>

where P: TLVBuilderParent,

pub fn path( self, endpoint: u16, cluster: u32, cmd: u32, ) -> Result<CmdDataBuilder<P, 1>, Error>

Write the concrete (endpoint, cluster, command) path. Wildcards aren’t meaningful for invokes — every send targets a concrete (endpoint, cluster, command) triple. The path is encoded as a list per spec CommandPathIB.

pub fn path_from(self, path: &CmdPath) -> Result<CmdDataBuilder<P, 1>, Error>

Write the path from an existing crate::im::CmdPath. Used by the snapshot→streaming bridge in ImClient::invoke.

impl<P> CmdDataBuilder<P, 1>

where P: TLVBuilderParent,

pub fn data<F>(self, f: F) -> Result<CmdDataBuilder<P, 2>, Error>

where F: FnOnce(&mut <P as TLVBuilderParent>::Write) -> Result<(), Error>,

Write the command request body into the Data slot.

Per Matter Core spec CommandDataIB.Data is the command’s request payload — any TLV element tagged TLVTag::Context(1) (= CmdDataTag::Data). For commands with no request fields (e.g. OnOff::On, OnOff::Toggle) the data slot is still required: write an empty struct.

Idiomatic call patterns:

// No-payload command (e.g. OnOff::Toggle):
.data(|w| {
    w.start_struct(&TLVTag::Context(CmdDataTag::Data as u8))?;
    w.end_container()
})?

// Any `T: ToTLV` request body:
.data(|w| req.to_tlv(&TLVTag::Context(CmdDataTag::Data as u8), w))?

// Via a codegen-emitted typed request builder:
.data(|w| MoveToHueRequestBuilder::new(w, ...)?
            .hue(180)? .direction(...)? .end())?

pub fn data_builder<B>(self) -> Result<B, Error>

where B: TLVBuilder<CmdDataBuilder<P, 2>>,

Open the Data slot as a typed sub-builder.

Closure-free counterpart to data — hand back the codegen-emitted request builder for the command, already opened at CmdDataTag::Data. The caller fills the request fields, then calls .end() on the sub-builder; that close writes Data’s closing tag and yields a CmdDataBuilder<P, 2>. The caller then .end()s once more to close the CmdData entry struct itself (the “double-end” pattern of the IM-client glue).

Soundness of the phantom typestate advance: B::new is contractually required (by TLVBuilder) to open exactly one container at the supplied tag, and B’s terminal .end() closes it. So by the time the caller observes the returned CmdDataBuilder<P, 2>, the Data field has been fully written and the typestate matches the wire state.

impl<P> CmdDataBuilder<P, 2>

where P: TLVBuilderParent,

pub fn command_ref(self, value: u16) -> Result<CmdDataBuilder<P, 3>, Error>

Write the optional CommandRef field. Mandatory when the InvokeRequests array carries more than one entry (per spec - the server echoes this back so the client can correlate responses to requests). For single-command invokes, omit (go straight to .end()).

impl<P> CmdDataBuilder<P, 2>

where P: TLVBuilderParent,

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

Close the CmdData struct, implicitly skipping CommandRef. Returns the array builder so the caller can .push() another entry or .end() the array.

impl<P> CmdDataBuilder<P, 3>

where P: TLVBuilderParent,

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

Close the CmdData struct and return the array builder.

Trait Implementations

impl<P, const F: usize> Debug for CmdDataBuilder<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 CmdDataBuilder<P>

where P: TLVBuilderParent,

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

where P: TLVBuilderParent,

type Write = <P as TLVBuilderParent>::Write

The type of the writer.

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

Return a mutable reference to the writer.