Struct Label 

pub struct Label {
    pub name: &'static str,
    pub pid: Option<NonZero<usize>>,
}

Agent-specific identifier that uniquely identifies an instance over the course of a simulation run.

It renders as a string containing the base name - usually the type name, but user-definable by setting the name during agent building or by implementing Behavior::name - followed by a pound symbol and an instance number, e.g. "JamesBond#7". The name is pretty printed by default but can be written out by using alternative formatting:

let agent = pin!(Agent::new((Rc::new(MyAgent), MyAgent::actions)));
let puck = sim.activate(agent);

// outputs "Rc<MyAgent>#1"
println!("{}", puck.label());

// outputs "alloc::rc::Rc<lab::MyAgent>#1"
println!("{:#}", puck.label());

Fields

name: &'static str

The agent name.

pid: Option<NonZero<usize>>

The agent-name-specific ID.

Implementations

impl Label

pub fn pretty_name(&self) -> impl Iterator<Item = &'static str>

Returns an iterator of string slices into the agent name that corresponds to a pretty-printed version of the type path.

The implementation is stolen inspired by Jakob Hellermann’s pretty-type-name crate, adapted to use a heapless iterator rather than a String.

Trait Implementations

impl Clone for Label

fn clone(&self) -> Label

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Label

impl Debug for Label

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

Formats the value using the given formatter.

impl Default for Label

fn default() -> Label

Returns the “default value” for a type.

impl Display for Label

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

Formats the value using the given formatter.

impl Eq for Label

impl PartialEq for Label

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for Label