Trait ClusterHandler 

pub trait ClusterHandler {
    const CLUSTER: Cluster<'static>;

    // Required methods
    fn dataver(&self) -> u32;
    fn dataver_changed(&self);
    fn description<P>(
        &self,
        ctx: impl ReadContext,
        builder: Utf8StrBuilder<P>,
    ) -> Result<P, Error>
       where P: TLVBuilderParent;
    fn standard_namespace(
        &self,
        ctx: impl ReadContext,
    ) -> Result<Maybe<u16, AsNullable>, Error>;
    fn supported_modes<P>(
        &self,
        ctx: impl ReadContext,
        builder: ArrayAttributeRead<ModeOptionStructArrayBuilder<P>, ModeOptionStructBuilder<P>>,
    ) -> Result<P, Error>
       where P: TLVBuilderParent;
    fn current_mode(&self, ctx: impl ReadContext) -> Result<u8, Error>;
    fn handle_change_to_mode(
        &self,
        ctx: impl InvokeContext,
        request: ChangeToModeRequest<'_>,
    ) -> 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 start_up_mode(
        &self,
        ctx: impl ReadContext,
    ) -> Result<Maybe<u8, AsNullable>, Error> { ... }
    fn on_mode(
        &self,
        ctx: impl ReadContext,
    ) -> Result<Maybe<u8, AsNullable>, Error> { ... }
    fn set_start_up_mode(
        &self,
        ctx: impl WriteContext,
        value: Maybe<u8, AsNullable>,
    ) -> Result<(), Error> { ... }
    fn set_on_mode(
        &self,
        ctx: impl WriteContext,
        value: Maybe<u8, AsNullable>,
    ) -> Result<(), Error> { ... }
}

The handler trait for the cluster.

Required Associated Constants

const CLUSTER: Cluster<'static>

The cluster-metadata corresponding to this handler trait.

Required Methods

fn dataver(&self) -> u32

fn dataver_changed(&self)

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

where P: TLVBuilderParent,

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

fn supported_modes<P>( &self, ctx: impl ReadContext, builder: ArrayAttributeRead<ModeOptionStructArrayBuilder<P>, ModeOptionStructBuilder<P>>, ) -> Result<P, Error>

where P: TLVBuilderParent,

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

fn handle_change_to_mode( &self, ctx: impl InvokeContext, request: ChangeToModeRequest<'_>, ) -> 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 start_up_mode( &self, ctx: impl ReadContext, ) -> Result<Maybe<u8, AsNullable>, Error>

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

fn set_start_up_mode( &self, ctx: impl WriteContext, value: Maybe<u8, AsNullable>, ) -> Result<(), Error>

fn set_on_mode( &self, ctx: impl WriteContext, value: Maybe<u8, 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

impl<T> ClusterHandler for &T

where T: ClusterHandler,

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

fn dataver(&self) -> u32

fn dataver_changed(&self)

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

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

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

where P: TLVBuilderParent,

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

fn supported_modes<P>( &self, ctx: impl ReadContext, builder: ArrayAttributeRead<ModeOptionStructArrayBuilder<P>, ModeOptionStructBuilder<P>>, ) -> Result<P, Error>

where P: TLVBuilderParent,

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

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

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

fn set_start_up_mode( &self, ctx: impl WriteContext, value: Maybe<u8, AsNullable>, ) -> Result<(), Error>

fn set_on_mode( &self, ctx: impl WriteContext, value: Maybe<u8, AsNullable>, ) -> Result<(), Error>

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

Implementors