Expand description
Generated cluster module
Structs§
- Handler
Adaptor - The handler adaptor for the cluster-specific handler. This adaptor implements the generic
rs-matterhandler trait. - Handler
Async Adaptor - The handler adaptor for the cluster-specific handler. This adaptor implements the generic
rs-matterhandler trait. - Proxy
Valid Attr Reads View - Cluster-scoped view onto an
crate::im::AttrPathArrayBuilderfor theProxyValidcluster. Each method pushes oneAttrPath(cluster ID baked in) and returnsSelffor chaining;.end()closes the underlying array. Attribute names that would collide with the view’s own inherent methods (seeRESERVED_VIEW_METHOD_NAMESin the codegen) get anattr_prefix. - Proxy
Valid Attr Responses View - Cluster-scoped response view onto a
crate::im::ReportDataRespfor theProxyValidcluster. Each method returns an iterator of(EndptId, Result<T, Error>)over the entries inattr_reportswhose path matches that attribute. Attribute names that would collide with the view’s own inherent methods (seeRESERVED_VIEW_METHOD_NAMESin the codegen) get anattr_prefix. - Proxy
Valid Attr Writes View - Cluster-scoped view onto an
crate::im::AttrDataArrayBuilderfor theProxyValidcluster. Scalar-valued attrs push and returnSelffor chaining; struct/list-valued attrs return the codegen-emitted typed value builder (whose parent chain bypasses the view — close back to the array via Data + AttrData.end()?s)..end()closes the wrapped array. Attribute names that would collide with the view’s own inherent methods (seeRESERVED_VIEW_METHOD_NAMESin the codegen) get anattr_prefix. - Proxy
Valid Client View - Per-exchange view onto the
ProxyValidcluster’s client operations. Returned byProxyValidClient::proxy_valid. Each method consumes the view (and therefore the underlyingcrate::transport::exchange::Exchange) — one exchange is one IM transaction. - Proxy
Valid CmdRequests View - Cluster-scoped view onto a
crate::im::CmdDataArrayBuilderfor theProxyValidcluster. Empty-request commands push and returnSelf; parameterized commands return the codegen-emitted typed request builder (whose parent chain bypasses the view — close back to the array via Data + CmdData.end()?s)..end()closes the wrapped array. Command names that would collide with the view’s own inherent methods (seeRESERVED_VIEW_METHOD_NAMESin the codegen — currentlyend, which the WebRTC cluster uses) get acmd_prefix. - Proxy
Valid CmdResponses View - Cluster-scoped response view onto a
crate::im::InvokeRespfor theProxyValidcluster. Each method returns an iterator of(EndptId, Result<R, Error>)over the entries ininvoke_responseswhose path matches that command. Command names that would collide with the view’s own inherent methods (seeRESERVED_VIEW_METHOD_NAMESin the codegen) get acmd_prefix. - Proxy
Valid Write Responses View - Cluster-scoped write-status view onto a
crate::im::WriteRespfor theProxyValidcluster. Each method returns an iterator of(EndptId, Result<(), Error>)over the entries inwrite_responseswhose path matches that attribute. Attribute names that would collide with the view’s own inherent methods (seeRESERVED_VIEW_METHOD_NAMESin the codegen) get anattr_prefix.
Enums§
- Attribute
Id - The attribute IDs for the cluster.
- Command
Id - The command IDs for the cluster.
- Command
Response Id - The command response IDs for the cluster.
- EventId
- The event IDs for the cluster.
Constants§
- FULL_
CLUSTER - The cluster metadata. By default, all cluster attributes, commands and events are allowed, and the revision is the latest one. Use
Cluster::with_*to reconfigure.
Traits§
- Cluster
Async Handler - The handler trait for the cluster.
- Cluster
Handler - The handler trait for the cluster.
- Proxy
Valid Attr Reads - IM-client extension trait for the
ProxyValidcluster’s attribute reads.usethis trait to call.proxy_valid_read()on ancrate::im::AttrPathArrayBuilder; the returnedProxyValidAttrReadsViewexposes one method per attribute (cluster-prefix-free)..end()on the view closes the wrapped array. - Proxy
Valid Attr Responses - IM-client extension trait for extracting
ProxyValid-cluster attribute reports out of a genericcrate::im::ReportDataResp.usethis trait to call.proxy_valid_read_resp()on aReportDataResp; the returnedProxyValidAttrResponsesViewexposes one iterator method per attribute (scalar, string, struct and list alike), each yielding(EndptId, Result<T, Error>). The item type borrows the response, so string/struct/list attributes come back asUtf8Str<'a>/OctetStr<'a>, the codegen struct wrapperFoo<'a>, orTLVArray<'a, _>respectively. - Proxy
Valid Attr Writes - IM-client extension trait for the
ProxyValidcluster’s attribute writes.usethis trait to call.proxy_valid_write()on ancrate::im::AttrDataArrayBuilder; the returnedProxyValidAttrWritesViewexposes one method per writable attribute (cluster-prefix-free)..end()on the view closes the wrapped array. - Proxy
Valid Client - Single-shot IM-client convenience trait for the
ProxyValidcluster.usethis trait to call.proxy_valid()on ancrate::transport::exchange::Exchange; the returnedProxyValidClientViewexposes one method per command and per attribute. Scalar attributes get a by-value<attr>_read(endpoint); non-scalar ones (string/octet/struct/list, whose value borrows the response) get<attr>_read_with(endpoint, |v| …), which hands the borrowed value to the closure and returns its owned result. The cluster ID, command/attribute ID, request opcode, retransmit loop, response-chunk iteration, and status-only handling are all baked in. DefaultSuccess commands returnResult<(), Error>and drain the response internally; response-bearing commands returnResult<<RespStruct>Handle<'a>, Error>— the handle keeps the RX buffer alive so the caller can read the borrowed response via.response()?before.complete().await?ing the exchange. - Proxy
Valid CmdRequests - IM-client extension trait for the
ProxyValidcluster’s commands.usethis trait to call.proxy_valid_inv()on acrate::im::CmdDataArrayBuilder; the returnedProxyValidCmdRequestsViewexposes one method per command (cluster-prefix-free)..end()on the view closes the wrapped array. - Proxy
Valid CmdResponses - IM-client extension trait for extracting
ProxyValid-cluster command responses out of a genericcrate::im::InvokeResp.usethis trait to call.proxy_valid_inv_resp()on anInvokeResp; the returnedProxyValidCmdResponsesViewexposes one iterator method per command, each yielding(EndptId, Result<<Output>, Error>)— seecrate::im::InvokeResp::responses/crate::im::InvokeResp::statusesfor the per-entry semantics. - Proxy
Valid Write Responses - IM-client extension trait for extracting
ProxyValid-cluster per-attribute write statuses out of a genericcrate::im::WriteResp.usethis trait to call.proxy_valid_write_resp()on aWriteResp; the returnedProxyValidWriteResponsesViewexposes one iterator method per writable attribute, each yielding(EndptId, Result<(), Error>).