Struct act_zero::Addr

pub struct Addr<T: ?Sized + 'static> { /* fields omitted */ }

A strong reference to a spawned actor. Actors can be spawned using Addr::new.

Methods can be called on the actor after it has been spawned using the send!(...) and call!(...) macros.

Can be converted to the address of a trait-object using the upcast!(...) macro.

Implementations

impl<T: Actor> Addr<T>

pub fn new<S: Spawn + ?Sized>(spawner: &S, value: T) -> Result<Self, SpawnError>

Spawn an actor using the given spawner. If successful returns the address of the actor.

impl<T: ?Sized> Addr<T>

pub fn detached() -> Self

Create an address which does not refer to any actor.

impl<T: ?Sized + Send + 'static> Addr<T>

pub fn downgrade(&self) -> WeakAddr<T>

Downgrade to a weak reference, which does not try to keep the actor alive.

pub fn downcast<U: Send + 'static>(self) -> Result<Addr<U>, Addr<T>>

Attempt to downcast the address of a "trait-object actor" to a concrete type.

This function may succeed even when the cast would normally be unsuccessful if the address has become detached.

Trait Implementations

impl<T: Actor + ?Sized> AddrLike for Addr<T>

type Actor = T

Type of the actor reference by this address.

pub fn send_fut(&self, fut: impl Future<Output = ()> + Send + 'static)

Spawn a future onto the actor which does not return a value.

pub fn call_fut<R: Send + 'static>(
    &self,
    fut: impl Future<Output = Produces<R>> + Send + 'static
) -> Produces<R>

Spawn a future onto the actor and provide the means to get back the result. The future will be cancelled if the receiver is dropped before it has completed.

pub fn send_fut_with<F: Future<Output = ()> + Send + 'static>(
    &self,
    f: impl FnOnce(Self) -> F
)

Equivalent to send_fut but provides access to the actor's address.

pub fn call_fut_with<R: Send + 'static, F: Future<Output = Produces<R>> + Send + 'static>(
    &self,
    f: impl FnOnce(Self) -> F
) -> Produces<R>

Equivalent to call_fut but provides access to the actor's address.

pub fn termination(&self) -> Termination

Returns a future which resolves when the actor terminates. If the actor has already terminated, or if this address is detached, the future will resolve immediately.

impl<T: Actor + ?Sized> AsAddr for Addr<T>

type Addr = Self

The inner address type

pub fn as_addr(&self) -> &Self::Addr

Obtain a direct reference to the address

impl<T: ?Sized> Clone for Addr<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: ?Sized> Debug for Addr<T>

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

Formats the value using the given formatter.

impl<T: ?Sized> Default for Addr<T>

pub fn default() -> Self

Returns the "default value" for a type.

impl<T: ?Sized> Eq for Addr<T>

impl<T: ?Sized> Hash for Addr<T>

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

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: ?Sized> Ord for Addr<T>

pub fn cmp(&self, rhs: &Addr<T>) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<T: ?Sized, U: ?Sized> PartialEq<Addr<U>> for Addr<T>

pub fn eq(&self, rhs: &Addr<U>) -> 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 !=.

impl<T: ?Sized, U: ?Sized> PartialEq<Addr<U>> for WeakAddr<T>

pub fn eq(&self, rhs: &Addr<U>) -> 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 !=.

impl<T: ?Sized, U: ?Sized> PartialEq<WeakAddr<U>> for Addr<T>

pub fn eq(&self, rhs: &WeakAddr<U>) -> 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 !=.

impl<T: ?Sized, U: ?Sized> PartialOrd<Addr<U>> for Addr<T>

pub fn partial_cmp(&self, rhs: &Addr<U>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: ?Sized, U: ?Sized> PartialOrd<Addr<U>> for WeakAddr<T>

pub fn partial_cmp(&self, rhs: &Addr<U>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: ?Sized, U: ?Sized> PartialOrd<WeakAddr<U>> for Addr<T>

pub fn partial_cmp(&self, rhs: &WeakAddr<U>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.