Trait overclock::core::Actor

pub trait Actor<S>: Sized + Sendwhere
    S: Send,{
    type Data: Send + 'static;
    type Channel: Channel;

    const VERSION: usize = 1usize;

    fn init<'life0, 'life1, 'async_trait>(
        &'life0 mut self,
        rt: &'life1 mut Rt<Self, S>
    ) -> Pin<Box<dyn Future<Output = ActorResult<Self::Data>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        'life1: 'async_trait,
        Self: 'async_trait;
    fn run<'life0, 'life1, 'async_trait>(
        &'life0 mut self,
        rt: &'life1 mut Rt<Self, S>,
        data: Self::Data
    ) -> Pin<Box<dyn Future<Output = ActorResult<()>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        'life1: 'async_trait,
        Self: 'async_trait;

    fn type_name() -> &'static str { ... }
}

The all-important Actor trait. This defines an Actor and what it do.

Required Associated Types

type Data: Send + 'static

Allows specifying an actor’s startup dependencies and data.

type Channel: Channel

The type of channel this actor will use to receive events

Provided Associated Constants

const VERSION: usize = 1usize

The version of the actor state

Required Methods

fn init<'life0, 'life1, 'async_trait>(
    &'life0 mut self,
    rt: &'life1 mut Rt<Self, S>
) -> Pin<Box<dyn Future<Output = ActorResult<Self::Data>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait,

Used to initialize the actor.

fn run<'life0, 'life1, 'async_trait>(
    &'life0 mut self,
    rt: &'life1 mut Rt<Self, S>,
    data: Self::Data
) -> Pin<Box<dyn Future<Output = ActorResult<()>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait,

The main function for the actor

Provided Methods

fn type_name() -> &'static str

Get this actor’s type name

Implementors