Struct ghost_actor::GhostActor

pub struct GhostActor<T: 'static + Send>(_);

GhostActor manages task efficient sequential mutable access to internal state data (type T). GhostActors are 'static and cheaply clone-able. A clone retains a channel to the same internal state data.

Implementations

impl<T: 'static + Send> GhostActor<T>

pub fn new(t: T) -> (Self, GhostDriver)

Create a new GhostActor with default config and initial state.

pub fn new_config(config: GhostConfig, t: T) -> (Self, GhostDriver)

Create a new GhostActor with config and initial state.

pub fn to_boxed(&self) -> BoxGhostActor

Get a type-erased BoxGhostActor version of this handle.

pub fn invoke_async<R, E, F>(&self, invoke: F) -> GhostFuture<R, E> where
    R: 'static + Send,
    E: 'static + From<GhostError> + Send,
    F: FnOnce(&mut T) -> Result<GhostFuture<R, E>, E> + 'static + Send, 

Push state read/mutation logic onto actor queue for processing, uses invoke() internally - but expects a future to be returned which is awaited internally to be more ergonomic.

pub fn invoke<R, E, F>(&self, invoke: F) -> GhostFuture<R, E> where
    R: 'static + Send,
    E: 'static + From<GhostError> + Send,
    F: FnOnce(&mut T) -> Result<R, E> + 'static + Send, 

Push state read/mutation logic onto actor queue for processing.

pub fn is_active(&self) -> bool

Returns true if the channel is still connected to the actor task.

pub fn shutdown(&self)

Close the channel to the actor task. This will result in the task being dropped once all pending invocations have been processed.

Trait Implementations

impl<T: 'static + Send> AsGhostActor for GhostActor<T>

pub fn __invoke(
    &self,
    invoke: RawInvokeClosure
) -> GhostFuture<Box<dyn Any + Send + 'static>, GhostError>

Raw type-erased invoke function. You probably want to use a higher-level function with better type safety.

pub fn __is_active(&self) -> bool

Returns true if the channel is still connected to the actor task.

pub fn __shutdown(&self)

Close the channel to the actor task. This will result in the task being dropped once all pending invocations have been processed.

pub fn __box_debug(&self, f: &mut Formatter<'_>) -> Result

Allows Debug from Box trait objects.

pub fn __box_clone(&self) -> Box<dyn AsGhostActor>

Allows Clone from Box trait objects.

pub fn __box_eq(&self, o: &dyn Any) -> bool

Allows PartialEq/Eq from Box trait objects.

pub fn __box_hash(&self, hasher: &mut dyn Hasher)

Allows Hash from Box trait objects.

impl<T: 'static + Send> Clone for GhostActor<T>

pub fn clone(&self) -> Self

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: 'static + Send> Debug for GhostActor<T>

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: 'static + Send> Eq for GhostActor<T>

impl<T: 'static + Send> Hash for GhostActor<T>

pub fn hash<Hasher: Hasher>(&self, state: &mut Hasher)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<T: 'static + Send> PartialEq<GhostActor<T>> for GhostActor<T>

pub fn eq(&self, o: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.