Struct ProcMeshId 

pub struct ProcMeshId(/* private fields */);

Identifies a proc mesh.

Implementations

impl ProcMeshId

pub fn new(uid: Uid, label: Option<Label>) -> Self

Create a mesh id with explicit uid and label.

pub fn singleton(label: Label) -> Self

Create a singleton mesh id identified by label.

pub fn instance(label: Label) -> Self

Create an instance mesh id with a random uid and the given label.

pub fn uid(&self) -> &Uid

Returns the uid.

pub fn label(&self) -> Option<&Label>

Returns the explicit label metadata, if any.

pub fn display_label(&self) -> Option<&Label>

Returns the human-facing label for this mesh id.

Telemetry uses this for given_name.

pub fn resource_id(&self) -> &ResourceId

Returns the inner ResourceId.

pub fn default_instance_label() -> &'static str

Returns the default instance label for this mesh id type.

impl ProcMeshId

pub fn proc_id(&self) -> ProcId

Converts this mesh id into a hyperactor proc id.

pub fn proc_addr(&self, location: impl Into<Location>) -> ProcAddr

Converts this mesh id into a hyperactor proc addr at location.

Trait Implementations

impl Clone for ProcMeshId

fn clone(&self) -> ProcMeshId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProcMeshId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProcMeshId

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ProcMeshId

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

Formats the value using the given formatter.

impl From<ProcMeshId> for ResourceId

fn from(id: ProcMeshId) -> Self

Converts to this type from the input type.

impl From<ResourceId> for ProcMeshId

fn from(id: ResourceId) -> Self

Converts to this type from the input type.

impl FromStr for ProcMeshId

type Err = ResourceIdParseError

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 ProcMeshId

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 ProcMeshId

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 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.

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

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

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 ProcMeshId

fn cmp(&self, other: &ProcMeshId) -> 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 ProcMeshId

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

fn partial_cmp(&self, other: &ProcMeshId) -> 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 ProcMeshId

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 ProcMeshId

impl StructuralPartialEq for ProcMeshId