Struct syndicate::actor::Ref

pub struct Ref<M> {
    pub mailbox: Arc<Mailbox>,
    pub facet_id: FacetId,
    pub target: Mutex<Option<Box<dyn Entity<M>>>>,
}

A reference to an object that expects messages/assertions of type M.

The object can be in the same actor, in a different local (in-process) actor, or accessible across a network link.

Fields

mailbox: Arc<Mailbox>

Mailbox of the actor owning the referenced entity.

facet_id: FacetId

ID of the facet (within the actor) owning the referenced entity.

target: Mutex<Option<Box<dyn Entity<M>>>>

Mutex owning and guarding the state backing the referenced entity.

Implementations

impl<M> Ref<M>

pub fn become_entity<E: 'static + Entity<M>>(&self, e: E)

Supplies the behaviour (e) for a Ref created via create_inert.

Panics

Panics if this Ref has already been given a behaviour.

impl<M> Ref<M>

pub fn oid(&self) -> usize

Retrieves a process-unique identifier for the Ref; Refs are compared by this identifier.

pub fn debug_str(&self) -> String

Trait Implementations

impl<M> Debug for Ref<M>

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

Formats the value using the given formatter.

impl<M> From<&Ref<M>> for Target

fn from(v: &Ref<M>) -> Target

Converts to this type from the input type.

impl<M> Hash for Ref<M>

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

where H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<M> Ord for Ref<M>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<M> PartialEq for Ref<M>

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

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<M> PartialOrd for Ref<M>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

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

fn lt(&self, other: &Rhs) -> bool

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

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

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

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<M> Eq for Ref<M>