Skip to main content

Module proxy_valid

Module proxy_valid 

Source
Expand description

Generated cluster module

Structs§

HandlerAdaptor
The handler adaptor for the cluster-specific handler. This adaptor implements the generic rs-matter handler trait.
HandlerAsyncAdaptor
The handler adaptor for the cluster-specific handler. This adaptor implements the generic rs-matter handler trait.
ProxyValidAttrReadsView
Cluster-scoped view onto an crate::im::AttrPathArrayBuilder for the ProxyValid cluster. Each method pushes one AttrPath (cluster ID baked in) and returns Self for chaining; .end() closes the underlying array. Attribute names that would collide with the view’s own inherent methods (see RESERVED_VIEW_METHOD_NAMES in the codegen) get an attr_ prefix.
ProxyValidAttrResponsesView
Cluster-scoped response view onto a crate::im::ReportDataResp for the ProxyValid cluster. Each method returns an iterator of (EndptId, Result<T, Error>) over the entries in attr_reports whose path matches that attribute. Attribute names that would collide with the view’s own inherent methods (see RESERVED_VIEW_METHOD_NAMES in the codegen) get an attr_ prefix.
ProxyValidAttrWritesView
Cluster-scoped view onto an crate::im::AttrDataArrayBuilder for the ProxyValid cluster. Scalar-valued attrs push and return Self for 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 (see RESERVED_VIEW_METHOD_NAMES in the codegen) get an attr_ prefix.
ProxyValidClientView
Per-exchange view onto the ProxyValid cluster’s client operations. Returned by ProxyValidClient::proxy_valid. Each method consumes the view (and therefore the underlying crate::transport::exchange::Exchange) — one exchange is one IM transaction.
ProxyValidCmdRequestsView
Cluster-scoped view onto a crate::im::CmdDataArrayBuilder for the ProxyValid cluster. Empty-request commands push and return Self; 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 (see RESERVED_VIEW_METHOD_NAMES in the codegen — currently end, which the WebRTC cluster uses) get a cmd_ prefix.
ProxyValidCmdResponsesView
Cluster-scoped response view onto a crate::im::InvokeResp for the ProxyValid cluster. Each method returns an iterator of (EndptId, Result<R, Error>) over the entries in invoke_responses whose path matches that command. Command names that would collide with the view’s own inherent methods (see RESERVED_VIEW_METHOD_NAMES in the codegen) get a cmd_ prefix.
ProxyValidWriteResponsesView
Cluster-scoped write-status view onto a crate::im::WriteResp for the ProxyValid cluster. Each method returns an iterator of (EndptId, Result<(), Error>) over the entries in write_responses whose path matches that attribute. Attribute names that would collide with the view’s own inherent methods (see RESERVED_VIEW_METHOD_NAMES in the codegen) get an attr_ prefix.

Enums§

AttributeId
The attribute IDs for the cluster.
CommandId
The command IDs for the cluster.
CommandResponseId
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§

ClusterAsyncHandler
The handler trait for the cluster.
ClusterHandler
The handler trait for the cluster.
ProxyValidAttrReads
IM-client extension trait for the ProxyValid cluster’s attribute reads. use this trait to call .proxy_valid_read() on an crate::im::AttrPathArrayBuilder; the returned ProxyValidAttrReadsView exposes one method per attribute (cluster-prefix-free). .end() on the view closes the wrapped array.
ProxyValidAttrResponses
IM-client extension trait for extracting ProxyValid-cluster attribute reports out of a generic crate::im::ReportDataResp. use this trait to call .proxy_valid_read_resp() on a ReportDataResp; the returned ProxyValidAttrResponsesView exposes 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 as Utf8Str<'a>/OctetStr<'a>, the codegen struct wrapper Foo<'a>, or TLVArray<'a, _> respectively.
ProxyValidAttrWrites
IM-client extension trait for the ProxyValid cluster’s attribute writes. use this trait to call .proxy_valid_write() on an crate::im::AttrDataArrayBuilder; the returned ProxyValidAttrWritesView exposes one method per writable attribute (cluster-prefix-free). .end() on the view closes the wrapped array.
ProxyValidClient
Single-shot IM-client convenience trait for the ProxyValid cluster. use this trait to call .proxy_valid() on an crate::transport::exchange::Exchange; the returned ProxyValidClientView exposes 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 return Result<(), Error> and drain the response internally; response-bearing commands return Result<<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.
ProxyValidCmdRequests
IM-client extension trait for the ProxyValid cluster’s commands. use this trait to call .proxy_valid_inv() on a crate::im::CmdDataArrayBuilder; the returned ProxyValidCmdRequestsView exposes one method per command (cluster-prefix-free). .end() on the view closes the wrapped array.
ProxyValidCmdResponses
IM-client extension trait for extracting ProxyValid-cluster command responses out of a generic crate::im::InvokeResp. use this trait to call .proxy_valid_inv_resp() on an InvokeResp; the returned ProxyValidCmdResponsesView exposes one iterator method per command, each yielding (EndptId, Result<<Output>, Error>) — see crate::im::InvokeResp::responses / crate::im::InvokeResp::statuses for the per-entry semantics.
ProxyValidWriteResponses
IM-client extension trait for extracting ProxyValid-cluster per-attribute write statuses out of a generic crate::im::WriteResp. use this trait to call .proxy_valid_write_resp() on a WriteResp; the returned ProxyValidWriteResponsesView exposes one iterator method per writable attribute, each yielding (EndptId, Result<(), Error>).