Skip to main content

ClusterHandler

Trait ClusterHandler 

Source
pub trait ClusterHandler {
    const CLUSTER: Cluster<'static>;
Show 34 methods // Required methods fn dataver(&self) -> u32; fn dataver_changed(&self); fn data_model_revision(&self, ctx: impl ReadContext) -> Result<u16, Error>; fn vendor_name<P>( &self, ctx: impl ReadContext, builder: Utf8StrBuilder<P>, ) -> Result<P, Error> where P: TLVBuilderParent; fn vendor_id(&self, ctx: impl ReadContext) -> Result<u16, Error>; fn product_name<P>( &self, ctx: impl ReadContext, builder: Utf8StrBuilder<P>, ) -> Result<P, Error> where P: TLVBuilderParent; fn product_id(&self, ctx: impl ReadContext) -> Result<u16, Error>; fn node_label<P>( &self, ctx: impl ReadContext, builder: Utf8StrBuilder<P>, ) -> Result<P, Error> where P: TLVBuilderParent; fn location<P>( &self, ctx: impl ReadContext, builder: Utf8StrBuilder<P>, ) -> Result<P, Error> where P: TLVBuilderParent; fn hardware_version(&self, ctx: impl ReadContext) -> Result<u16, Error>; fn hardware_version_string<P>( &self, ctx: impl ReadContext, builder: Utf8StrBuilder<P>, ) -> Result<P, Error> where P: TLVBuilderParent; fn software_version(&self, ctx: impl ReadContext) -> Result<u32, Error>; fn software_version_string<P>( &self, ctx: impl ReadContext, builder: Utf8StrBuilder<P>, ) -> Result<P, Error> where P: TLVBuilderParent; fn capability_minima<P>( &self, ctx: impl ReadContext, builder: CapabilityMinimaStructBuilder<P>, ) -> Result<P, Error> where P: TLVBuilderParent; fn set_node_label( &self, ctx: impl WriteContext, value: &str, ) -> Result<(), Error>; fn set_location( &self, ctx: impl WriteContext, value: &str, ) -> Result<(), Error>; fn handle_mfg_specific_ping( &self, ctx: impl InvokeContext, ) -> Result<(), Error>; // Provided methods fn lifecycle( &self, _ctx: impl HandlerContext, _op: LifecycleOp, ) -> Result<(), Error> { ... } fn run( &self, _ctx: impl HandlerContext, ) -> impl Future<Output = Result<(), Error>> { ... } fn manufacturing_date<P>( &self, ctx: impl ReadContext, builder: Utf8StrBuilder<P>, ) -> Result<P, Error> where P: TLVBuilderParent { ... } fn part_number<P>( &self, ctx: impl ReadContext, builder: Utf8StrBuilder<P>, ) -> Result<P, Error> where P: TLVBuilderParent { ... } fn product_url<P>( &self, ctx: impl ReadContext, builder: Utf8StrBuilder<P>, ) -> Result<P, Error> where P: TLVBuilderParent { ... } fn product_label<P>( &self, ctx: impl ReadContext, builder: Utf8StrBuilder<P>, ) -> Result<P, Error> where P: TLVBuilderParent { ... } fn serial_number<P>( &self, ctx: impl ReadContext, builder: Utf8StrBuilder<P>, ) -> Result<P, Error> where P: TLVBuilderParent { ... } fn local_config_disabled( &self, ctx: impl ReadContext, ) -> Result<bool, Error> { ... } fn reachable(&self, ctx: impl ReadContext) -> Result<bool, Error> { ... } fn unique_id<P>( &self, ctx: impl ReadContext, builder: Utf8StrBuilder<P>, ) -> Result<P, Error> where P: TLVBuilderParent { ... } fn product_appearance<P>( &self, ctx: impl ReadContext, builder: ProductAppearanceStructBuilder<P>, ) -> Result<P, Error> where P: TLVBuilderParent { ... } fn specification_version(&self, ctx: impl ReadContext) -> Result<u32, Error> { ... } fn max_paths_per_invoke(&self, ctx: impl ReadContext) -> Result<u16, Error> { ... } fn device_location<P>( &self, ctx: impl ReadContext, builder: NullableBuilder<P, LocationDescriptorStructBuilder<P>>, ) -> Result<P, Error> where P: TLVBuilderParent { ... } fn configuration_version(&self, ctx: impl ReadContext) -> Result<u32, Error> { ... } fn set_local_config_disabled( &self, ctx: impl WriteContext, value: bool, ) -> Result<(), Error> { ... } fn set_device_location( &self, ctx: impl WriteContext, value: Maybe<LocationDescriptorStruct<'_>, AsNullable>, ) -> Result<(), Error> { ... }
}
Expand description

The handler trait for the cluster.

Required Associated Constants§

Source

const CLUSTER: Cluster<'static>

The cluster-metadata corresponding to this handler trait.

Required Methods§

Source

fn dataver(&self) -> u32

Source

fn dataver_changed(&self)

Source

fn data_model_revision(&self, ctx: impl ReadContext) -> Result<u16, Error>

Source

fn vendor_name<P>( &self, ctx: impl ReadContext, builder: Utf8StrBuilder<P>, ) -> Result<P, Error>

Source

fn vendor_id(&self, ctx: impl ReadContext) -> Result<u16, Error>

Source

fn product_name<P>( &self, ctx: impl ReadContext, builder: Utf8StrBuilder<P>, ) -> Result<P, Error>

Source

fn product_id(&self, ctx: impl ReadContext) -> Result<u16, Error>

Source

fn node_label<P>( &self, ctx: impl ReadContext, builder: Utf8StrBuilder<P>, ) -> Result<P, Error>

Source

fn location<P>( &self, ctx: impl ReadContext, builder: Utf8StrBuilder<P>, ) -> Result<P, Error>

Source

fn hardware_version(&self, ctx: impl ReadContext) -> Result<u16, Error>

Source

fn hardware_version_string<P>( &self, ctx: impl ReadContext, builder: Utf8StrBuilder<P>, ) -> Result<P, Error>

Source

fn software_version(&self, ctx: impl ReadContext) -> Result<u32, Error>

Source

fn software_version_string<P>( &self, ctx: impl ReadContext, builder: Utf8StrBuilder<P>, ) -> Result<P, Error>

Source

fn capability_minima<P>( &self, ctx: impl ReadContext, builder: CapabilityMinimaStructBuilder<P>, ) -> Result<P, Error>

Source

fn set_node_label( &self, ctx: impl WriteContext, value: &str, ) -> Result<(), Error>

Source

fn set_location(&self, ctx: impl WriteContext, value: &str) -> Result<(), Error>

Source

fn handle_mfg_specific_ping(&self, ctx: impl InvokeContext) -> Result<(), Error>

Provided Methods§

Source

fn lifecycle( &self, _ctx: impl HandlerContext, _op: LifecycleOp, ) -> Result<(), Error>

Source

fn run( &self, _ctx: impl HandlerContext, ) -> impl Future<Output = Result<(), Error>>

Source

fn manufacturing_date<P>( &self, ctx: impl ReadContext, builder: Utf8StrBuilder<P>, ) -> Result<P, Error>

Source

fn part_number<P>( &self, ctx: impl ReadContext, builder: Utf8StrBuilder<P>, ) -> Result<P, Error>

Source

fn product_url<P>( &self, ctx: impl ReadContext, builder: Utf8StrBuilder<P>, ) -> Result<P, Error>

Source

fn product_label<P>( &self, ctx: impl ReadContext, builder: Utf8StrBuilder<P>, ) -> Result<P, Error>

Source

fn serial_number<P>( &self, ctx: impl ReadContext, builder: Utf8StrBuilder<P>, ) -> Result<P, Error>

Source

fn local_config_disabled(&self, ctx: impl ReadContext) -> Result<bool, Error>

Source

fn reachable(&self, ctx: impl ReadContext) -> Result<bool, Error>

Source

fn unique_id<P>( &self, ctx: impl ReadContext, builder: Utf8StrBuilder<P>, ) -> Result<P, Error>

Source

fn product_appearance<P>( &self, ctx: impl ReadContext, builder: ProductAppearanceStructBuilder<P>, ) -> Result<P, Error>

Source

fn specification_version(&self, ctx: impl ReadContext) -> Result<u32, Error>

Source

fn max_paths_per_invoke(&self, ctx: impl ReadContext) -> Result<u16, Error>

Source

fn device_location<P>( &self, ctx: impl ReadContext, builder: NullableBuilder<P, LocationDescriptorStructBuilder<P>>, ) -> Result<P, Error>

Source

fn configuration_version(&self, ctx: impl ReadContext) -> Result<u32, Error>

Source

fn set_local_config_disabled( &self, ctx: impl WriteContext, value: bool, ) -> Result<(), Error>

Source

fn set_device_location( &self, ctx: impl WriteContext, value: Maybe<LocationDescriptorStruct<'_>, AsNullable>, ) -> Result<(), Error>

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementations on Foreign Types§

Source§

impl<T> ClusterHandler for &T
where T: ClusterHandler,

Source§

const CLUSTER: Cluster<'static> = T::CLUSTER

Source§

fn dataver(&self) -> u32

Source§

fn dataver_changed(&self)

Source§

fn lifecycle( &self, ctx: impl HandlerContext, op: LifecycleOp, ) -> Result<(), Error>

Source§

fn run( &self, ctx: impl HandlerContext, ) -> impl Future<Output = Result<(), Error>>

Source§

fn data_model_revision(&self, ctx: impl ReadContext) -> Result<u16, Error>

Source§

fn vendor_name<P>( &self, ctx: impl ReadContext, builder: Utf8StrBuilder<P>, ) -> Result<P, Error>

Source§

fn vendor_id(&self, ctx: impl ReadContext) -> Result<u16, Error>

Source§

fn product_name<P>( &self, ctx: impl ReadContext, builder: Utf8StrBuilder<P>, ) -> Result<P, Error>

Source§

fn product_id(&self, ctx: impl ReadContext) -> Result<u16, Error>

Source§

fn node_label<P>( &self, ctx: impl ReadContext, builder: Utf8StrBuilder<P>, ) -> Result<P, Error>

Source§

fn location<P>( &self, ctx: impl ReadContext, builder: Utf8StrBuilder<P>, ) -> Result<P, Error>

Source§

fn hardware_version(&self, ctx: impl ReadContext) -> Result<u16, Error>

Source§

fn hardware_version_string<P>( &self, ctx: impl ReadContext, builder: Utf8StrBuilder<P>, ) -> Result<P, Error>

Source§

fn software_version(&self, ctx: impl ReadContext) -> Result<u32, Error>

Source§

fn software_version_string<P>( &self, ctx: impl ReadContext, builder: Utf8StrBuilder<P>, ) -> Result<P, Error>

Source§

fn manufacturing_date<P>( &self, ctx: impl ReadContext, builder: Utf8StrBuilder<P>, ) -> Result<P, Error>

Source§

fn part_number<P>( &self, ctx: impl ReadContext, builder: Utf8StrBuilder<P>, ) -> Result<P, Error>

Source§

fn product_url<P>( &self, ctx: impl ReadContext, builder: Utf8StrBuilder<P>, ) -> Result<P, Error>

Source§

fn product_label<P>( &self, ctx: impl ReadContext, builder: Utf8StrBuilder<P>, ) -> Result<P, Error>

Source§

fn serial_number<P>( &self, ctx: impl ReadContext, builder: Utf8StrBuilder<P>, ) -> Result<P, Error>

Source§

fn local_config_disabled(&self, ctx: impl ReadContext) -> Result<bool, Error>

Source§

fn reachable(&self, ctx: impl ReadContext) -> Result<bool, Error>

Source§

fn unique_id<P>( &self, ctx: impl ReadContext, builder: Utf8StrBuilder<P>, ) -> Result<P, Error>

Source§

fn capability_minima<P>( &self, ctx: impl ReadContext, builder: CapabilityMinimaStructBuilder<P>, ) -> Result<P, Error>

Source§

fn product_appearance<P>( &self, ctx: impl ReadContext, builder: ProductAppearanceStructBuilder<P>, ) -> Result<P, Error>

Source§

fn specification_version(&self, ctx: impl ReadContext) -> Result<u32, Error>

Source§

fn max_paths_per_invoke(&self, ctx: impl ReadContext) -> Result<u16, Error>

Source§

fn device_location<P>( &self, ctx: impl ReadContext, builder: NullableBuilder<P, LocationDescriptorStructBuilder<P>>, ) -> Result<P, Error>

Source§

fn configuration_version(&self, ctx: impl ReadContext) -> Result<u32, Error>

Source§

fn set_node_label( &self, ctx: impl WriteContext, value: &str, ) -> Result<(), Error>

Source§

fn set_location(&self, ctx: impl WriteContext, value: &str) -> Result<(), Error>

Source§

fn set_local_config_disabled( &self, ctx: impl WriteContext, value: bool, ) -> Result<(), Error>

Source§

fn set_device_location( &self, ctx: impl WriteContext, value: Maybe<LocationDescriptorStruct<'_>, AsNullable>, ) -> Result<(), Error>

Source§

fn handle_mfg_specific_ping(&self, ctx: impl InvokeContext) -> Result<(), Error>

Implementors§