Enum Reference

pub enum Reference {
    World(WorldId),
    Proc(ProcId),
    Actor(ActorId),
    Port(PortId),
    Gang(GangId),
}

A universal reference to hierarchical identifiers in Hyperactor.

References implement a concrete syntax which can be parsed via FromStr. They are of the form:

• world,
• world[rank],
• world[rank].actor[pid],
• world[rank].port[pid][port], or
• world.actor

Reference also implements a total ordering, so that references are ordered lexicographically with the hierarchy implied by world, proc, actor. This allows reference ordering to be used to implement prefix based routing.

Variants

World(WorldId)

A reference to a world.

Proc(ProcId)

A reference to a proc.

Actor(ActorId)

A reference to an actor.

Port(PortId)

A reference to a port.

Gang(GangId)

A reference to a gang.

Implementations

impl Reference

pub fn is_world(&self) -> bool

Returns true if this is a Reference::World, otherwise false

pub fn as_world_mut(&mut self) -> Option<&mut WorldId>

Optionally returns mutable references to the inner fields if this is a Reference::World, otherwise None

pub fn as_world(&self) -> Option<&WorldId>

Optionally returns references to the inner fields if this is a Reference::World, otherwise None

pub fn into_world(self) -> Result<WorldId, Self>

Returns the inner fields if this is a Reference::World, otherwise returns back the enum in the Err case of the result

pub fn is_proc(&self) -> bool

Returns true if this is a Reference::Proc, otherwise false

pub fn as_proc_mut(&mut self) -> Option<&mut ProcId>

Optionally returns mutable references to the inner fields if this is a Reference::Proc, otherwise None

pub fn as_proc(&self) -> Option<&ProcId>

Optionally returns references to the inner fields if this is a Reference::Proc, otherwise None

pub fn into_proc(self) -> Result<ProcId, Self>

Returns the inner fields if this is a Reference::Proc, otherwise returns back the enum in the Err case of the result

pub fn is_actor(&self) -> bool

Returns true if this is a Reference::Actor, otherwise false

pub fn as_actor_mut(&mut self) -> Option<&mut ActorId>

Optionally returns mutable references to the inner fields if this is a Reference::Actor, otherwise None

pub fn as_actor(&self) -> Option<&ActorId>

Optionally returns references to the inner fields if this is a Reference::Actor, otherwise None

pub fn into_actor(self) -> Result<ActorId, Self>

Returns the inner fields if this is a Reference::Actor, otherwise returns back the enum in the Err case of the result

pub fn is_port(&self) -> bool

Returns true if this is a Reference::Port, otherwise false

pub fn as_port_mut(&mut self) -> Option<&mut PortId>

Optionally returns mutable references to the inner fields if this is a Reference::Port, otherwise None

pub fn as_port(&self) -> Option<&PortId>

Optionally returns references to the inner fields if this is a Reference::Port, otherwise None

pub fn into_port(self) -> Result<PortId, Self>

Returns the inner fields if this is a Reference::Port, otherwise returns back the enum in the Err case of the result

pub fn is_gang(&self) -> bool

Returns true if this is a Reference::Gang, otherwise false

pub fn as_gang_mut(&mut self) -> Option<&mut GangId>

Optionally returns mutable references to the inner fields if this is a Reference::Gang, otherwise None

pub fn as_gang(&self) -> Option<&GangId>

Optionally returns references to the inner fields if this is a Reference::Gang, otherwise None

pub fn into_gang(self) -> Result<GangId, Self>

Returns the inner fields if this is a Reference::Gang, otherwise returns back the enum in the Err case of the result

impl Reference

pub fn is_prefix_of(&self, other: &Reference) -> bool

Tells whether this reference is a prefix of the provided reference.

pub fn world_id(&self) -> Option<&WorldId>

The world id of the reference.

pub fn proc_id(&self) -> Option<&ProcId>

The proc id of the reference, if any.

pub fn actor_id(&self) -> Option<&ActorId>

The actor id of the reference, if any.

Trait Implementations

impl Clone for Reference

fn clone(&self) -> Reference

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Reference

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Reference

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Reference

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

Formats the value using the given formatter.

impl From<ActorId> for Reference

fn from(actor_id: ActorId) -> Self

Converts to this type from the input type.

impl From<GangId> for Reference

fn from(gang_id: GangId) -> Self

Converts to this type from the input type.

impl From<PortId> for Reference

fn from(port_id: PortId) -> Self

Converts to this type from the input type.

impl From<ProcId> for Reference

fn from(proc_id: ProcId) -> Self

Converts to this type from the input type.

impl From<WorldId> for Reference

fn from(world_id: WorldId) -> Self

Converts to this type from the input type.

impl FromStr for Reference

type Err = ReferenceParsingError

The associated error which can be returned from parsing.

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

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

impl Hash for Reference

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Named for Reference

fn typename() -> &'static str

The globally unique type name for the type. This should typically be the fully qualified Rust name of the type.

fn typehash() -> u64

A globally unique hash for this type. TODO: actually enforce perfect hashing

fn arm(&self) -> Option<&'static str>

If the named type is an enum, this returns the name of the arm of the value self.

fn typeid() -> TypeId

The TypeId for this type. TypeIds are unique only within a binary, and should not be used for global identification.

fn port() -> u64

The globally unique port for this type. Typed ports are in the range of 1<<63..1<<64-1.

unsafe fn arm_unchecked(self_: *const ()) -> Option<&'static str>

An unsafe version of ‘arm’, accepting a pointer to the value, for use in type-erased settings.

impl Ord for Reference

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,

Restrict a value to a certain interval.

impl PartialEq for Reference

fn eq(&self, other: &Reference) -> 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 PartialOrd for Reference

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for Reference

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Reference

impl StructuralPartialEq for Reference