Struct kay::RawID

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

A raw (untyped) ID referring to an actor class instance

Fields

instance_id: u32

instance ID within the class

type_id: ShortTypeId

actual type of the instance (always points to a concrete class even if this RawID is contained in a TypedID representing an actor trait)

machine: MachineID

The machine in the networking topology this instance lives on

version: u8

A version of the ID to be able to safelyreuse instance IDs after an actor dies.

Methods

impl RawID

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

Create a new RawID from its parts

pub fn local_broadcast(&self) -> RawID

Convert a given RawID into one that represents a local broadcast

pub fn global_broadcast(&self) -> RawID

Convert a given RawID into one that represents a global broadcast

pub fn is_broadcast(&self) -> bool

Check whether this RawID represents a (local || global) broadcast

pub fn is_global_broadcast(&self) -> bool

Check whether this RawID represents a global broadcast

pub fn format(&self, world: &mut World) -> String

Get the canonical string format of a RawID

Trait Implementations

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 Copy for RawID

impl Debug for RawID

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

Formats the value using the given formatter.

impl Display for RawID

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

Formats the value using the given formatter.

impl Eq for RawID

impl FromStr for RawID

type Err = ParseRawIDError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

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 PartialEq<RawID> 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 StructuralEq for RawID

impl StructuralPartialEq for RawID