Struct kay::RawID

pub struct RawID {
    pub type_id: ShortTypeId,
    pub machine: MachineID,
    pub version: u8,
    pub instance_id: u32,
}

A RawID uniquely identifies an Actor, or even a Actor within a Swarm

Fields

type_id: ShortTypeId

An ID for the type of the identified Actor, used to dispatch messages to the message handling functions registered for this type

machine: MachineID

ID of the machine (in a computing cluster or multiplayer environment) that the identified Actor lives on

version: u8

Allows safe reuse of a RawID after Actor/Actor death. The version is incremented to make the new (otherwise identical) RawID distinguishable from erroneous references to the Actor/Actor previously identified

instance_id: u32

Used to identify instances within a top-level Actor. The main use-case is Swarm identifying and dispatching to its Instances using this field

Methods

impl RawID

pub fn new(     type_id: ShortTypeId,     instance_id: u32,     machine: MachineID,     version: u8 ) -> Self

Create a new RawID

pub fn local_broadcast(&self) -> RawID

Get a version of an actor RawID that signals that a message should be delivered to all machine-local instances.

pub fn global_broadcast(&self) -> RawID

Get a version of an actor RawID that signals that a message should be delivered globally (to all instances on all machines).

pub fn is_broadcast(&self) -> bool

Check whether this RawID signals a local or global broadcast.

pub fn is_global_broadcast(&self) -> bool

Check whether this RawID signals specifically a global broadcast.

Trait Implementations

impl Copy for RawID

impl Clone for RawID

fn clone(&self) -> RawID

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq for RawID

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

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

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

This method tests for !=.

impl Eq for RawID

impl Hash for RawID

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl Debug for RawID

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.