Expand description
Generated cluster module
Structs§
- AddGroup
IfIdentifying Request - AddGroup
IfIdentifying Request Array Builder - AddGroup
IfIdentifying Request Builder - AddGroup
Request - AddGroup
Request Array Builder - AddGroup
Request Builder - AddGroup
Response - AddGroup
Response Array Builder - AddGroup
Response Builder - AddGroup
Response Handle - Single-shot handle wrapping the [
InvokeRespChunk] of aAddGroupResponseresponse. Holds the exchange’s RX buffer alive;response()parses the embeddedCommandDataIBinto a borrowedAddGroupResponse. The trailingStatusResponse(Success)is sent when the caller.complete().await?s the handle. - Feature
- GetGroup
Membership Request - GetGroup
Membership Request Array Builder - GetGroup
Membership Request Builder - GetGroup
Membership Response - GetGroup
Membership Response Array Builder - GetGroup
Membership Response Builder - GetGroup
Membership Response Handle - Single-shot handle wrapping the [
InvokeRespChunk] of aGetGroupMembershipResponseresponse. Holds the exchange’s RX buffer alive;response()parses the embeddedCommandDataIBinto a borrowedGetGroupMembershipResponse. The trailingStatusResponse(Success)is sent when the caller.complete().await?s the handle. - Groups
Attr Reads View - Cluster-scoped view onto an
crate::im::AttrPathArrayBuilderfor theGroupscluster. 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. - Groups
Attr Responses View - Cluster-scoped response view onto a
crate::im::ReportDataRespfor theGroupscluster. 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. - Groups
Attr Writes View - Cluster-scoped view onto an
crate::im::AttrDataArrayBuilderfor theGroupscluster. 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. - Groups
Client View - Per-exchange view onto the
Groupscluster’s client operations. Returned byGroupsClient::groups. Each method consumes the view (and therefore the underlyingcrate::transport::exchange::Exchange) — one exchange is one IM transaction. - Groups
CmdRequests View - Cluster-scoped view onto a
crate::im::CmdDataArrayBuilderfor theGroupscluster. 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. - Groups
CmdResponses View - Cluster-scoped response view onto a
crate::im::InvokeRespfor theGroupscluster. 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. - Groups
Write Responses View - Cluster-scoped write-status view onto a
crate::im::WriteRespfor theGroupscluster. 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. - 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. - Name
Support Bitmap - Remove
Group Request - Remove
Group Request Array Builder - Remove
Group Request Builder - Remove
Group Response - Remove
Group Response Array Builder - Remove
Group Response Builder - Remove
Group Response Handle - Single-shot handle wrapping the [
InvokeRespChunk] of aRemoveGroupResponseresponse. Holds the exchange’s RX buffer alive;response()parses the embeddedCommandDataIBinto a borrowedRemoveGroupResponse. The trailingStatusResponse(Success)is sent when the caller.complete().await?s the handle. - View
Group Request - View
Group Request Array Builder - View
Group Request Builder - View
Group Response - View
Group Response Array Builder - View
Group Response Builder - View
Group Response Handle - Single-shot handle wrapping the [
InvokeRespChunk] of aViewGroupResponseresponse. Holds the exchange’s RX buffer alive;response()parses the embeddedCommandDataIBinto a borrowedViewGroupResponse. The trailingStatusResponse(Success)is sent when the caller.complete().await?s the handle.
Enums§
- AddGroup
IfIdentifying Request Tag - AddGroup
Request Tag - AddGroup
Response Tag - 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.
- GetGroup
Membership Request Tag - GetGroup
Membership Response Tag - Remove
Group Request Tag - Remove
Group Response Tag - View
Group Request Tag - View
Group Response Tag
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.
- Groups
Attr Reads - IM-client extension trait for the
Groupscluster’s attribute reads.usethis trait to call.groups_read()on ancrate::im::AttrPathArrayBuilder; the returnedGroupsAttrReadsViewexposes one method per attribute (cluster-prefix-free)..end()on the view closes the wrapped array. - Groups
Attr Responses - IM-client extension trait for extracting
Groups-cluster attribute reports out of a genericcrate::im::ReportDataResp.usethis trait to call.groups_read_resp()on aReportDataResp; the returnedGroupsAttrResponsesViewexposes 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. - Groups
Attr Writes - IM-client extension trait for the
Groupscluster’s attribute writes.usethis trait to call.groups_write()on ancrate::im::AttrDataArrayBuilder; the returnedGroupsAttrWritesViewexposes one method per writable attribute (cluster-prefix-free)..end()on the view closes the wrapped array. - Groups
Client - Single-shot IM-client convenience trait for the
Groupscluster.usethis trait to call.groups()on ancrate::transport::exchange::Exchange; the returnedGroupsClientViewexposes 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. - Groups
CmdRequests - IM-client extension trait for the
Groupscluster’s commands.usethis trait to call.groups_inv()on acrate::im::CmdDataArrayBuilder; the returnedGroupsCmdRequestsViewexposes one method per command (cluster-prefix-free)..end()on the view closes the wrapped array. - Groups
CmdResponses - IM-client extension trait for extracting
Groups-cluster command responses out of a genericcrate::im::InvokeResp.usethis trait to call.groups_inv_resp()on anInvokeResp; the returnedGroupsCmdResponsesViewexposes one iterator method per command, each yielding(EndptId, Result<<Output>, Error>)— seecrate::im::InvokeResp::responses/crate::im::InvokeResp::statusesfor the per-entry semantics. - Groups
Write Responses - IM-client extension trait for extracting
Groups-cluster per-attribute write statuses out of a genericcrate::im::WriteResp.usethis trait to call.groups_write_resp()on aWriteResp; the returnedGroupsWriteResponsesViewexposes one iterator method per writable attribute, each yielding(EndptId, Result<(), Error>).