Skip to main content

AliasRegistry

Struct AliasRegistry 

Source
pub struct AliasRegistry { /* private fields */ }
Expand description

Bidirectional name↔alias bindings plus a datatype index, scoped to one Edge Node or Device.

Implementations§

Source§

impl AliasRegistry

Source

pub fn new() -> Self

An empty registry.

Source

pub fn bind(&mut self, name: &str, alias: Option<u64>, datatype: DataType)

Bind a metric’s name (and optional alias) to its datatype, as declared in a BIRTH. Overwrites any existing binding for the same name/alias; use AliasRegistry::try_bind to enforce the duplicate-alias-is-fatal rule.

Source

pub fn try_bind( &mut self, name: &str, alias: Option<u64>, datatype: DataType, ) -> Result<()>

Like AliasRegistry::bind, but rejects an alias already bound to a different name — a duplicate alias in a BIRTH is fatal per the spec.

§Errors

Returns SparkplugError::InvalidId if alias is already bound to a different metric name.

Source

pub fn datatype_for_name(&self, name: &str) -> Option<DataType>

The datatype declared for name, if any.

Source

pub fn datatype_for_alias(&self, alias: u64) -> Option<DataType>

The datatype declared for alias, if any.

Source

pub fn datatype_for(&self, key: &MetricKey) -> Option<DataType>

The datatype for a MetricKey.

Source

pub fn name_for_alias(&self, alias: u64) -> Option<&str>

The name bound to alias, if any.

Source

pub fn alias_for_name(&self, name: &str) -> Option<u64>

The alias bound to name, if any.

Source

pub fn alias_exists(&self, alias: u64) -> bool

Whether alias is already bound (to detect duplicate aliases in a birth).

Source

pub fn clear(&mut self)

Clear every binding (call before re-binding on a new birth).

Trait Implementations§

Source§

impl Clone for AliasRegistry

Source§

fn clone(&self) -> AliasRegistry

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AliasRegistry

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for AliasRegistry

Source§

fn default() -> AliasRegistry

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.