Skip to main content

ResourceId

hyperactor_mesh::mesh_id

Struct ResourceId

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

Expand description

Identifies a resource in the mesh system.

Identity (Eq, Hash, Ord) is determined by the underlying Uid.

Implementations§

impl ResourceId

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

Create a ResourceId with explicit uid and label.

pub fn singleton(label: Label) -> Self

Create a singleton ResourceId identified by label. The label becomes the uid; no separate label metadata is stored.

pub fn instance(label: Label) -> Self

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

pub fn from_name(name: impl AsRef<str>) -> Self

Create a resource id from a resource-name string.

This accepts the mesh resource-id grammar, falling back to a stripped singleton label for legacy call sites that pass arbitrary names.

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

This is the explicit label metadata for instances, or the singleton label embedded in the uid. Telemetry uses this for given_name.

pub fn proc_id(&self) -> ProcId

Converts this resource id into a hyperactor proc id.

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

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

pub fn proc_addr_from_name( location: impl Into<Location>, name: impl AsRef<str>, ) -> ProcAddr

Creates a hyperactor proc addr from a mesh resource-name string.

Trait Implementations§

impl Clone for ResourceId

fn clone(&self) -> ResourceId

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for ResourceId

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for ResourceId

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl Display for ResourceId

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

Formats the canonical control-plane string form of this resource id.

This string is used for resource message keys, proc names on hosts, and telemetry full_name.

impl From<&ProcAddr> for ResourceId

fn from(addr: &ProcAddr) -> Self

Converts to this type from the input type.

impl From<&ProcId> for ResourceId

fn from(id: &ProcId) -> Self

Converts to this type from the input type.

impl From<&ResourceId> for ProcId

fn from(id: &ResourceId) -> Self

Converts to this type from the input type.

impl From<&ResourceId> for Uid

fn from(id: &ResourceId) -> Self

Converts to this type from the input type.

impl From<ActorMeshId> for ResourceId

fn from(id: ActorMeshId) -> Self

Converts to this type from the input type.

impl From<HostMeshId> for ResourceId

fn from(id: HostMeshId) -> Self

Converts to this type from the input type.

impl From<ProcId> for ResourceId

fn from(id: ProcId) -> Self

Converts to this type from the input type.

impl From<ProcMeshId> for ResourceId

fn from(id: ProcMeshId) -> Self

Converts to this type from the input type.

impl From<ResourceId> for ActorMeshId

fn from(id: ResourceId) -> Self

Converts to this type from the input type.

impl From<ResourceId> for HostMeshId

fn from(id: ResourceId) -> Self

Converts to this type from the input type.

impl From<ResourceId> for ProcId

fn from(id: ResourceId) -> 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 From<ResourceId> for Uid

fn from(id: ResourceId) -> Self

Converts to this type from the input type.

impl FromStr for ResourceId

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

Parses the canonical resource-id string forms accepted by the mesh control plane.

Accepted inputs are:

label for singletons
label-uid58 for labeled instances

resource-uid58 parses as an instance without explicit label metadata.

type Err = ResourceIdParseError

The associated error which can be returned from parsing.

impl Hash for ResourceId

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

Feeds this value into the given Hasher. Read more

1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more

impl Named for ResourceId

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

impl Ord for ResourceId

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other. Read more

1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more

1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more

1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more

impl PartialEq for ResourceId

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

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

1.0.0 · Source§

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 ResourceId

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more

1.0.0 · Source§

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

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

1.0.0 · Source§

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

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

1.0.0 · Source§

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

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

1.0.0 · Source§

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

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

impl Serialize for ResourceId

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

impl Eq for ResourceId

Auto Trait Implementations§

impl Freeze for ResourceId

impl RefUnwindSafe for ResourceId

impl Send for ResourceId

impl Sync for ResourceId

impl Unpin for ResourceId

impl UnsafeUnpin for ResourceId

impl UnwindSafe for ResourceId

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.

impl<T> DynClone for T
where T: Clone,

fn __clone_box(&self, _: Private) -> *mut ()

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FromRef<T> for T
where T: Clone,

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.

impl<T> FutureExt for T

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more

impl<A, M> Handler<IndexedErasedUnbound<M>> for A
where A: Handler<M>, M: Castable,

fn handle<'life0, 'life1, 'async_trait>( &'life0 mut self, cx: &'life1 Context<'_, A>, msg: IndexedErasedUnbound<M>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, A: 'async_trait,

Handle the next M-typed message.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<T> IntoRequest<T> for T

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request

impl<L> LayerExt<L> for L

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in [Layered].

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> PolicyExt for T
where T: ?Sized,

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more

impl<T> QuoteExt for T
where T: ?Sized,

fn push_quoted<'q, Q, S>(&mut self, _q: Q, s: S)
where Q: QuoteInto<T>, S: Into<Quotable<'q>>,

impl<T> Same for T

type Output = T

Should always be Self

impl<T> Serialize for T
where T: Serialize + ?Sized,

fn erased_serialize(&self, serializer: &mut dyn Serializer) -> Result<(), Error>

fn do_erased_serialize( &self, serializer: &mut dyn Serializer, ) -> Result<(), ErrorImpl>

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToSmolStr for T
where T: Display + ?Sized,

fn to_smolstr(&self) -> SmolStr

impl<T> ToString for T
where T: Display + ?Sized,

fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more

impl<M> Accepts<M> for M
where M: RemoteMessage,

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

impl<M> Message for M
where M: Send + Sync + 'static,

impl<M> RemoteMessage for M
where M: Message + Named + Serialize + DeserializeOwned,