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 type(&self, ctx: impl ReadContext) -> Result<Type, Error>; fn config_status( &self, ctx: impl ReadContext, ) -> Result<ConfigStatus, Error>; fn operational_status( &self, ctx: impl ReadContext, ) -> Result<OperationalStatus, Error>; fn end_product_type( &self, ctx: impl ReadContext, ) -> Result<EndProductType, Error>; fn mode(&self, ctx: impl ReadContext) -> Result<Mode, Error>; fn set_mode(&self, ctx: impl WriteContext, value: Mode) -> Result<(), Error>; fn handle_up_or_open(&self, ctx: impl InvokeContext) -> Result<(), Error>; fn handle_down_or_close(&self, ctx: impl InvokeContext) -> Result<(), Error>; fn handle_stop_motion(&self, ctx: impl InvokeContext) -> Result<(), Error>; fn handle_go_to_lift_value( &self, ctx: impl InvokeContext, request: GoToLiftValueRequest<'_>, ) -> Result<(), Error>; fn handle_go_to_lift_percentage( &self, ctx: impl InvokeContext, request: GoToLiftPercentageRequest<'_>, ) -> Result<(), Error>; fn handle_go_to_tilt_value( &self, ctx: impl InvokeContext, request: GoToTiltValueRequest<'_>, ) -> Result<(), Error>; fn handle_go_to_tilt_percentage( &self, ctx: impl InvokeContext, request: GoToTiltPercentageRequest<'_>, ) -> 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 physical_closed_limit_lift( &self, ctx: impl ReadContext, ) -> Result<u16, Error> { ... } fn physical_closed_limit_tilt( &self, ctx: impl ReadContext, ) -> Result<u16, Error> { ... } fn current_position_lift( &self, ctx: impl ReadContext, ) -> Result<Maybe<u16, AsNullable>, Error> { ... } fn current_position_tilt( &self, ctx: impl ReadContext, ) -> Result<Maybe<u16, AsNullable>, Error> { ... } fn number_of_actuations_lift( &self, ctx: impl ReadContext, ) -> Result<u16, Error> { ... } fn number_of_actuations_tilt( &self, ctx: impl ReadContext, ) -> Result<u16, Error> { ... } fn current_position_lift_percentage( &self, ctx: impl ReadContext, ) -> Result<Maybe<u8, AsNullable>, Error> { ... } fn current_position_tilt_percentage( &self, ctx: impl ReadContext, ) -> Result<Maybe<u8, AsNullable>, Error> { ... } fn target_position_lift_percent_100_ths( &self, ctx: impl ReadContext, ) -> Result<Maybe<u16, AsNullable>, Error> { ... } fn target_position_tilt_percent_100_ths( &self, ctx: impl ReadContext, ) -> Result<Maybe<u16, AsNullable>, Error> { ... } fn current_position_lift_percent_100_ths( &self, ctx: impl ReadContext, ) -> Result<Maybe<u16, AsNullable>, Error> { ... } fn current_position_tilt_percent_100_ths( &self, ctx: impl ReadContext, ) -> Result<Maybe<u16, AsNullable>, Error> { ... } fn installed_open_limit_lift( &self, ctx: impl ReadContext, ) -> Result<u16, Error> { ... } fn installed_closed_limit_lift( &self, ctx: impl ReadContext, ) -> Result<u16, Error> { ... } fn installed_open_limit_tilt( &self, ctx: impl ReadContext, ) -> Result<u16, Error> { ... } fn installed_closed_limit_tilt( &self, ctx: impl ReadContext, ) -> Result<u16, Error> { ... } fn safety_status( &self, ctx: impl ReadContext, ) -> Result<SafetyStatus, 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§

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 physical_closed_limit_lift( &self, ctx: impl ReadContext, ) -> Result<u16, Error>

Source

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

Source

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

Source

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

Source

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

Source

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

Source

fn current_position_lift_percentage( &self, ctx: impl ReadContext, ) -> Result<Maybe<u8, AsNullable>, Error>

Source

fn current_position_tilt_percentage( &self, ctx: impl ReadContext, ) -> Result<Maybe<u8, AsNullable>, Error>

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

fn safety_status(&self, ctx: impl ReadContext) -> Result<SafetyStatus, 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 type(&self, ctx: impl ReadContext) -> Result<Type, Error>

Source§

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

Source§

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

Source§

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

Source§

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

Source§

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

Source§

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

Source§

fn config_status(&self, ctx: impl ReadContext) -> Result<ConfigStatus, Error>

Source§

fn current_position_lift_percentage( &self, ctx: impl ReadContext, ) -> Result<Maybe<u8, AsNullable>, Error>

Source§

fn current_position_tilt_percentage( &self, ctx: impl ReadContext, ) -> Result<Maybe<u8, AsNullable>, Error>

Source§

fn operational_status( &self, ctx: impl ReadContext, ) -> Result<OperationalStatus, Error>

Source§

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

Source§

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

Source§

fn end_product_type( &self, ctx: impl ReadContext, ) -> Result<EndProductType, Error>

Source§

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

Source§

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

Source§

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

Source§

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

Source§

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

Source§

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

Source§

fn mode(&self, ctx: impl ReadContext) -> Result<Mode, Error>

Source§

fn safety_status(&self, ctx: impl ReadContext) -> Result<SafetyStatus, Error>

Source§

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

Source§

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

Source§

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

Source§

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

Source§

fn handle_go_to_lift_value( &self, ctx: impl InvokeContext, request: GoToLiftValueRequest<'_>, ) -> Result<(), Error>

Source§

fn handle_go_to_lift_percentage( &self, ctx: impl InvokeContext, request: GoToLiftPercentageRequest<'_>, ) -> Result<(), Error>

Source§

fn handle_go_to_tilt_value( &self, ctx: impl InvokeContext, request: GoToTiltValueRequest<'_>, ) -> Result<(), Error>

Source§

fn handle_go_to_tilt_percentage( &self, ctx: impl InvokeContext, request: GoToTiltPercentageRequest<'_>, ) -> Result<(), Error>

Implementors§