Expand description
Generated cluster module
Structs§
- Bitmap8
Mask Map - Bitmap16
Mask Map - Bitmap32
Mask Map - Bitmap64
Mask Map - Boolean
Response - Boolean
Response Array Builder - Boolean
Response Builder - Boolean
Response Handle - Single-shot handle wrapping the [
InvokeRespChunk] of aBooleanResponseresponse. Holds the exchange’s RX buffer alive;response()parses the embeddedCommandDataIBinto a borrowedBooleanResponse. The trailingStatusResponse(Success)is sent when the caller.complete().await?s the handle. - Double
Nested Struct List - Double
Nested Struct List Array Builder - Double
Nested Struct List Builder - Global
Echo Request Request - Global
Echo Request Request Array Builder - Global
Echo Request Request Builder - Global
Echo Response - Global
Echo Response Array Builder - Global
Echo Response Builder - Global
Echo Response Handle - Single-shot handle wrapping the [
InvokeRespChunk] of aGlobalEchoResponseresponse. Holds the exchange’s RX buffer alive;response()parses the embeddedCommandDataIBinto a borrowedGlobalEchoResponse. The trailingStatusResponse(Success)is sent when the caller.complete().await?s the handle. - 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. - Nested
Struct - Nested
Struct Array Builder - Nested
Struct Builder - Nested
Struct List - Nested
Struct List Array Builder - Nested
Struct List Builder - Nullables
AndOptionals Struct - Nullables
AndOptionals Struct Array Builder - Nullables
AndOptionals Struct Builder - Simple
Bitmap - Simple
Struct - Simple
Struct Array Builder - Simple
Struct Builder - Simple
Struct Echo Request Request - Simple
Struct Echo Request Request Array Builder - Simple
Struct Echo Request Request Builder - Simple
Struct Response - Simple
Struct Response Array Builder - Simple
Struct Response Builder - Simple
Struct Response Handle - Single-shot handle wrapping the [
InvokeRespChunk] of aSimpleStructResponseresponse. Holds the exchange’s RX buffer alive;response()parses the embeddedCommandDataIBinto a borrowedSimpleStructResponse. The trailingStatusResponse(Success)is sent when the caller.complete().await?s the handle. - String
Echo Request Request - String
Echo Request Request Array Builder - String
Echo Request Request Builder - String
Echo Response - String
Echo Response Array Builder - String
Echo Response Builder - String
Echo Response Handle - Single-shot handle wrapping the [
InvokeRespChunk] of aStringEchoResponseresponse. Holds the exchange’s RX buffer alive;response()parses the embeddedCommandDataIBinto a borrowedStringEchoResponse. The trailingStatusResponse(Success)is sent when the caller.complete().await?s the handle. - Test
AddArguments Request - Test
AddArguments Request Array Builder - Test
AddArguments Request Builder - Test
AddArguments Response - Test
AddArguments Response Array Builder - Test
AddArguments Response Builder - Test
AddArguments Response Handle - Single-shot handle wrapping the [
InvokeRespChunk] of aTestAddArgumentsResponseresponse. Holds the exchange’s RX buffer alive;response()parses the embeddedCommandDataIBinto a borrowedTestAddArgumentsResponse. The trailingStatusResponse(Success)is sent when the caller.complete().await?s the handle. - Test
Batch Helper Request Request - Test
Batch Helper Request Request Array Builder - Test
Batch Helper Request Request Builder - Test
Batch Helper Response - Test
Batch Helper Response Array Builder - Test
Batch Helper Response Builder - Test
Batch Helper Response Handle - Single-shot handle wrapping the [
InvokeRespChunk] of aTestBatchHelperResponseresponse. Holds the exchange’s RX buffer alive;response()parses the embeddedCommandDataIBinto a borrowedTestBatchHelperResponse. The trailingStatusResponse(Success)is sent when the caller.complete().await?s the handle. - Test
Complex Nullable Optional Request Request - Test
Complex Nullable Optional Request Request Array Builder - Test
Complex Nullable Optional Request Request Builder - Test
Complex Nullable Optional Response - Test
Complex Nullable Optional Response Array Builder - Test
Complex Nullable Optional Response Builder - Test
Complex Nullable Optional Response Handle - Single-shot handle wrapping the [
InvokeRespChunk] of aTestComplexNullableOptionalResponseresponse. Holds the exchange’s RX buffer alive;response()parses the embeddedCommandDataIBinto a borrowedTestComplexNullableOptionalResponse. The trailingStatusResponse(Success)is sent when the caller.complete().await?s the handle. - Test
Different Vendor MeiEvent - Test
Different Vendor MeiEvent Array Builder - Test
Different Vendor MeiEvent Builder - Test
Different Vendor MeiRequest Request - Test
Different Vendor MeiRequest Request Array Builder - Test
Different Vendor MeiRequest Request Builder - Test
Different Vendor MeiResponse - Test
Different Vendor MeiResponse Array Builder - Test
Different Vendor MeiResponse Builder - Test
Different Vendor MeiResponse Handle - Single-shot handle wrapping the [
InvokeRespChunk] of aTestDifferentVendorMeiResponseresponse. Holds the exchange’s RX buffer alive;response()parses the embeddedCommandDataIBinto a borrowedTestDifferentVendorMeiResponse. The trailingStatusResponse(Success)is sent when the caller.complete().await?s the handle. - Test
Emit Test Event Request Request - Test
Emit Test Event Request Request Array Builder - Test
Emit Test Event Request Request Builder - Test
Emit Test Event Response - Test
Emit Test Event Response Array Builder - Test
Emit Test Event Response Builder - Test
Emit Test Event Response Handle - Single-shot handle wrapping the [
InvokeRespChunk] of aTestEmitTestEventResponseresponse. Holds the exchange’s RX buffer alive;response()parses the embeddedCommandDataIBinto a borrowedTestEmitTestEventResponse. The trailingStatusResponse(Success)is sent when the caller.complete().await?s the handle. - Test
Emit Test Fabric Scoped Event Request Request - Test
Emit Test Fabric Scoped Event Request Request Array Builder - Test
Emit Test Fabric Scoped Event Request Request Builder - Test
Emit Test Fabric Scoped Event Response - Test
Emit Test Fabric Scoped Event Response Array Builder - Test
Emit Test Fabric Scoped Event Response Builder - Test
Emit Test Fabric Scoped Event Response Handle - Single-shot handle wrapping the [
InvokeRespChunk] of aTestEmitTestFabricScopedEventResponseresponse. Holds the exchange’s RX buffer alive;response()parses the embeddedCommandDataIBinto a borrowedTestEmitTestFabricScopedEventResponse. The trailingStatusResponse(Success)is sent when the caller.complete().await?s the handle. - Test
Enums Request Request - Test
Enums Request Request Array Builder - Test
Enums Request Request Builder - Test
Enums Response - Test
Enums Response Array Builder - Test
Enums Response Builder - Test
Enums Response Handle - Single-shot handle wrapping the [
InvokeRespChunk] of aTestEnumsResponseresponse. Holds the exchange’s RX buffer alive;response()parses the embeddedCommandDataIBinto a borrowedTestEnumsResponse. The trailingStatusResponse(Success)is sent when the caller.complete().await?s the handle. - Test
Event - Test
Event Array Builder - Test
Event Builder - Test
Fabric Scoped - Test
Fabric Scoped Array Builder - Test
Fabric Scoped Builder - Test
Fabric Scoped Event - Test
Fabric Scoped Event Array Builder - Test
Fabric Scoped Event Builder - Test
List Int8U Argument Request Request - Test
List Int8U Argument Request Request Array Builder - Test
List Int8U Argument Request Request Builder - Test
List Int8U Reverse Request Request - Test
List Int8U Reverse Request Request Array Builder - Test
List Int8U Reverse Request Request Builder - Test
List Int8U Reverse Response - Test
List Int8U Reverse Response Array Builder - Test
List Int8U Reverse Response Builder - Test
List Int8U Reverse Response Handle - Single-shot handle wrapping the [
InvokeRespChunk] of aTestListInt8UReverseResponseresponse. Holds the exchange’s RX buffer alive;response()parses the embeddedCommandDataIBinto a borrowedTestListInt8UReverseResponse. The trailingStatusResponse(Success)is sent when the caller.complete().await?s the handle. - Test
List Nested Struct List Argument Request Request - Test
List Nested Struct List Argument Request Request Array Builder - Test
List Nested Struct List Argument Request Request Builder - Test
List Struct Argument Request Request - Test
List Struct Argument Request Request Array Builder - Test
List Struct Argument Request Request Builder - Test
List Struct Octet - Test
List Struct Octet Array Builder - Test
List Struct Octet Builder - Test
Nested Struct Argument Request Request - Test
Nested Struct Argument Request Request Array Builder - Test
Nested Struct Argument Request Request Builder - Test
Nested Struct List Argument Request Request - Test
Nested Struct List Argument Request Request Array Builder - Test
Nested Struct List Argument Request Request Builder - Test
Nullable Optional Request Request - Test
Nullable Optional Request Request Array Builder - Test
Nullable Optional Request Request Builder - Test
Nullable Optional Response - Test
Nullable Optional Response Array Builder - Test
Nullable Optional Response Builder - Test
Nullable Optional Response Handle - Single-shot handle wrapping the [
InvokeRespChunk] of aTestNullableOptionalResponseresponse. Holds the exchange’s RX buffer alive;response()parses the embeddedCommandDataIBinto a borrowedTestNullableOptionalResponse. The trailingStatusResponse(Success)is sent when the caller.complete().await?s the handle. - Test
Second Batch Helper Request Request - Test
Second Batch Helper Request Request Array Builder - Test
Second Batch Helper Request Request Builder - Test
Simple Argument Request Request - Test
Simple Argument Request Request Array Builder - Test
Simple Argument Request Request Builder - Test
Simple Argument Response - Test
Simple Argument Response Array Builder - Test
Simple Argument Response Builder - Test
Simple Argument Response Handle - Single-shot handle wrapping the [
InvokeRespChunk] of aTestSimpleArgumentResponseresponse. Holds the exchange’s RX buffer alive;response()parses the embeddedCommandDataIBinto a borrowedTestSimpleArgumentResponse. The trailingStatusResponse(Success)is sent when the caller.complete().await?s the handle. - Test
Simple Optional Argument Request Request - Test
Simple Optional Argument Request Request Array Builder - Test
Simple Optional Argument Request Request Builder - Test
Specific Response - Test
Specific Response Array Builder - Test
Specific Response Builder - Test
Specific Response Handle - Single-shot handle wrapping the [
InvokeRespChunk] of aTestSpecificResponseresponse. Holds the exchange’s RX buffer alive;response()parses the embeddedCommandDataIBinto a borrowedTestSpecificResponse. The trailingStatusResponse(Success)is sent when the caller.complete().await?s the handle. - Test
Struct Argument Request Request - Test
Struct Argument Request Request Array Builder - Test
Struct Argument Request Request Builder - Test
Struct Array Argument Request Request - Test
Struct Array Argument Request Request Array Builder - Test
Struct Array Argument Request Request Builder - Test
Struct Array Argument Response - Test
Struct Array Argument Response Array Builder - Test
Struct Array Argument Response Builder - Test
Struct Array Argument Response Handle - Single-shot handle wrapping the [
InvokeRespChunk] of aTestStructArrayArgumentResponseresponse. Holds the exchange’s RX buffer alive;response()parses the embeddedCommandDataIBinto a borrowedTestStructArrayArgumentResponse. The trailingStatusResponse(Success)is sent when the caller.complete().await?s the handle. - Unit
Testing Attr Reads View - Cluster-scoped view onto an
crate::im::AttrPathArrayBuilderfor theUnitTestingcluster. 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. - Unit
Testing Attr Responses View - Cluster-scoped response view onto a
crate::im::ReportDataRespfor theUnitTestingcluster. 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. - Unit
Testing Attr Writes View - Cluster-scoped view onto an
crate::im::AttrDataArrayBuilderfor theUnitTestingcluster. 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. - Unit
Testing Client View - Per-exchange view onto the
UnitTestingcluster’s client operations. Returned byUnitTestingClient::unit_testing. Each method consumes the view (and therefore the underlyingcrate::transport::exchange::Exchange) — one exchange is one IM transaction. - Unit
Testing CmdRequests View - Cluster-scoped view onto a
crate::im::CmdDataArrayBuilderfor theUnitTestingcluster. 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. - Unit
Testing CmdResponses View - Cluster-scoped response view onto a
crate::im::InvokeRespfor theUnitTestingcluster. 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. - Unit
Testing Write Responses View - Cluster-scoped write-status view onto a
crate::im::WriteRespfor theUnitTestingcluster. 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.
- Boolean
Response Tag - Command
Id - The command IDs for the cluster.
- Command
Response Id - The command response IDs for the cluster.
- Double
Nested Struct List Tag - EventId
- The event IDs for the cluster.
- Global
Echo Request Request Tag - Global
Echo Response Tag - Nested
Struct List Tag - Nested
Struct Tag - Nullables
AndOptionals Struct Tag - Simple
Enum - Simple
Struct Echo Request Request Tag - Simple
Struct Response Tag - Simple
Struct Tag - String
Echo Request Request Tag - String
Echo Response Tag - Test
AddArguments Request Tag - Test
AddArguments Response Tag - Test
Batch Helper Request Request Tag - Test
Batch Helper Response Tag - Test
Complex Nullable Optional Request Request Tag - Test
Complex Nullable Optional Response Tag - Test
Different Vendor MeiEvent Tag - Test
Different Vendor MeiRequest Request Tag - Test
Different Vendor MeiResponse Tag - Test
Emit Test Event Request Request Tag - Test
Emit Test Event Response Tag - Test
Emit Test Fabric Scoped Event Request Request Tag - Test
Emit Test Fabric Scoped Event Response Tag - Test
Enums Request Request Tag - Test
Enums Response Tag - Test
Event Tag - Test
Fabric Scoped Event Tag - Test
Fabric Scoped Tag - Test
List Int8U Argument Request Request Tag - Test
List Int8U Reverse Request Request Tag - Test
List Int8U Reverse Response Tag - Test
List Nested Struct List Argument Request Request Tag - Test
List Struct Argument Request Request Tag - Test
List Struct Octet Tag - Test
Nested Struct Argument Request Request Tag - Test
Nested Struct List Argument Request Request Tag - Test
Nullable Optional Request Request Tag - Test
Nullable Optional Response Tag - Test
Second Batch Helper Request Request Tag - Test
Simple Argument Request Request Tag - Test
Simple Argument Response Tag - Test
Simple Optional Argument Request Request Tag - Test
Specific Response Tag - Test
Struct Argument Request Request Tag - Test
Struct Array Argument Request Request Tag - Test
Struct Array Argument 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.
- Unit
Testing Attr Reads - IM-client extension trait for the
UnitTestingcluster’s attribute reads.usethis trait to call.unit_testing_read()on ancrate::im::AttrPathArrayBuilder; the returnedUnitTestingAttrReadsViewexposes one method per attribute (cluster-prefix-free)..end()on the view closes the wrapped array. - Unit
Testing Attr Responses - IM-client extension trait for extracting
UnitTesting-cluster attribute reports out of a genericcrate::im::ReportDataResp.usethis trait to call.unit_testing_read_resp()on aReportDataResp; the returnedUnitTestingAttrResponsesViewexposes 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. - Unit
Testing Attr Writes - IM-client extension trait for the
UnitTestingcluster’s attribute writes.usethis trait to call.unit_testing_write()on ancrate::im::AttrDataArrayBuilder; the returnedUnitTestingAttrWritesViewexposes one method per writable attribute (cluster-prefix-free)..end()on the view closes the wrapped array. - Unit
Testing Client - Single-shot IM-client convenience trait for the
UnitTestingcluster.usethis trait to call.unit_testing()on ancrate::transport::exchange::Exchange; the returnedUnitTestingClientViewexposes 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. - Unit
Testing CmdRequests - IM-client extension trait for the
UnitTestingcluster’s commands.usethis trait to call.unit_testing_inv()on acrate::im::CmdDataArrayBuilder; the returnedUnitTestingCmdRequestsViewexposes one method per command (cluster-prefix-free)..end()on the view closes the wrapped array. - Unit
Testing CmdResponses - IM-client extension trait for extracting
UnitTesting-cluster command responses out of a genericcrate::im::InvokeResp.usethis trait to call.unit_testing_inv_resp()on anInvokeResp; the returnedUnitTestingCmdResponsesViewexposes one iterator method per command, each yielding(EndptId, Result<<Output>, Error>)— seecrate::im::InvokeResp::responses/crate::im::InvokeResp::statusesfor the per-entry semantics. - Unit
Testing Write Responses - IM-client extension trait for extracting
UnitTesting-cluster per-attribute write statuses out of a genericcrate::im::WriteResp.usethis trait to call.unit_testing_write_resp()on aWriteResp; the returnedUnitTestingWriteResponsesViewexposes one iterator method per writable attribute, each yielding(EndptId, Result<(), Error>).