Skip to main content

NodeId

Struct NodeId 

Source
pub struct NodeId(/* private fields */);
Expand description

The id of a node in a dataflow — the id: field of a manifest node (blueprint §8.3).

Module expansion produces dotted composites (parent.child, §8.5), which is why . is part of the grammar.

§Examples

use astrs_wire::NodeId;

let id: NodeId = "perception.detector".parse()?;
assert_eq!(id.as_str(), "perception.detector");

Implementations§

Source§

impl NodeId

Source

pub const KIND: IdKind = IdKind::Node

The identifier family this type belongs to.

Source

pub const MAX_LEN: usize = MAX_NAME_LEN

The maximum length in bytes.

Source

pub fn new(value: impl Into<String>) -> Result<NodeId, IdError>

Validates value and wraps it as a node id.

§Errors

IdError if the value is empty, over MAX_NAME_LEN bytes, or outside [A-Za-z0-9_.-].

§Examples
use astrs_wire::NodeId;

assert!(NodeId::new("valid-01").is_ok());
assert!(NodeId::new("in valid").is_err());
Source

pub fn sanitized(value: &str) -> NodeId

Wraps value as a node id, repairing it if it does not fit the grammar.

A total constructor, for callers that must produce an identifier and have no error path to take: a reserved literal this crate itself defines, a metrics label derived from operator-supplied text, a fallback in a Display impl. Characters outside [A-Za-z0-9_.-] become _, the result is truncated to MAX_NAME_LEN bytes on a character boundary, and an empty result becomes "_" — so the returned value always satisfies the same invariant Self::new enforces.

Prefer Self::new wherever a malformed name is a real error worth reporting; silent repair is the right answer only when there is nobody to report it to.

§Examples
use astrs_wire::NodeId;

assert_eq!(NodeId::sanitized("camera.image").as_str(), "camera.image");
assert_eq!(NodeId::sanitized("in valid").as_str(), "in_valid");
assert_eq!(NodeId::sanitized("").as_str(), "_");
Source

pub fn as_str(&self) -> &str

The identifier as a string slice.

Source

pub fn into_string(self) -> String

Consumes the identifier and returns the inner String.

Source

pub fn len(&self) -> usize

The identifier’s length in bytes.

Source

pub fn is_empty(&self) -> bool

Always false — a validated identifier is never empty.

Provided because clippy (rightly) expects any type with len to offer is_empty; the constant answer documents the invariant.

Trait Implementations§

Source§

impl AsRef<str> for NodeId

Source§

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.
Source§

impl Borrow<str> for NodeId

Source§

fn borrow(&self) -> &str

Immutably borrows from an owned value. Read more
Source§

impl Clone for NodeId

Source§

fn clone(&self) -> NodeId

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 NodeId

Source§

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

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

impl<Context> Decode<Context> for NodeId

Source§

fn decode<D>(decoder: &mut D) -> Result<NodeId, Error>
where D: Decoder<Context = Context>,

Decode a value from the given decoder
Source§

impl<'de> Deserialize<'de> for NodeId

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for NodeId

Source§

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

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

impl Encode for NodeId

Source§

fn encode<E>(&self, encoder: &mut E) -> Result<(), Error>
where E: Encoder,

Encode this value into the given encoder
Source§

impl Eq for NodeId

Source§

impl FromStr for NodeId

Source§

type Err = IdError

The associated error which can be returned from parsing.
Source§

fn from_str(value: &str) -> Result<NodeId, <NodeId as FromStr>::Err>

Parses a string s to return a value of this type. Read more
Source§

impl Hash for NodeId

Source§

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

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

impl Ord for NodeId

Source§

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

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

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

Restrict a value to a certain interval. Read more
Source§

fn clamp_to<R>(self, range: R) -> Self
where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)
Restrict a value to a certain range. Read more
Source§

impl PartialEq for NodeId

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl PartialEq<&str> for NodeId

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl PartialEq<str> for NodeId

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl PartialOrd for NodeId

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · 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 (const: unstable) · 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 (const: unstable) · 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 (const: unstable) · 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
Source§

impl Serialize for NodeId

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for NodeId

Source§

impl TryFrom<&str> for NodeId

Source§

type Error = IdError

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

fn try_from(value: &str) -> Result<NodeId, <NodeId as TryFrom<&str>>::Error>

Performs the conversion.
Source§

impl TryFrom<String> for NodeId

Source§

type Error = IdError

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

fn try_from(value: String) -> Result<NodeId, <NodeId as TryFrom<String>>::Error>

Performs the conversion.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

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

Source§

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

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

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> MaybeDebug for T

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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

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

Source§

fn vzip(self) -> V

Source§

impl<T> WireDecode for T
where T: Decode,

Source§

fn decode_exact(bytes: &[u8]) -> Result<T, WireError>

Decodes a value that must occupy all of bytes. Read more
Source§

fn decode_prefix(bytes: &[u8]) -> Result<(T, usize), WireError>

Decodes a value from the front of bytes, returning it together with the number of bytes consumed. Read more
Source§

impl<T> WireEncode for T
where T: Encode,

Source§

fn encode_size_hint(&self) -> Result<usize, WireError>

The exact number of bytes WireEncode::encode_presized will produce. Read more
Source§

fn encode_presized(&self, out: &mut Vec<u8>) -> Result<usize, WireError>

Appends the encoded form to out, reserving the exact space first. Read more
Source§

fn encode_to_vec(&self) -> Result<Vec<u8>, WireError>

Encodes into a freshly allocated, exactly-sized Vec<u8>. Read more
Source§

impl<T> WithSubscriber for T

Source§

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

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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