Struct NodeId 

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

A validated node identifier.

A NodeId may contain only [a-zA-Z0-9_.-], must be non-empty, and must not start with . (dot-segments like . or .. could traverse into a parent directory when the id is joined into a filesystem path). Unlike DataId, a NodeId may not contain /, which separates <node_id>/<output_id> in input-mapping syntax.

The exact id dora is additionally reserved: it names the built-in input namespaces (dora/timer/..., dora/logs), which input-mapping parsing matches before any user node, so a node called dora could never be subscribed to. Only the exact string is reserved — dora-node, my-dora and Dora all remain valid.

Parsing vs. conversion (panic footgun)

Use str::parse / FromStr for untrusted input: it returns Result<NodeId, InvalidId>. The From<String> conversion — and therefore .into() and the auto-derived TryFrom<String> — panics on an invalid id.

use dora_message::id::NodeId;

// Fallible path — always safe for untrusted input:
assert!("camera_node".parse::<NodeId>().is_ok());
assert!("node/out".parse::<NodeId>().is_err()); // '/' is not allowed in a NodeId
assert!("".parse::<NodeId>().is_err());         // empty is rejected
assert!(".hidden".parse::<NodeId>().is_err());  // leading '.' is rejected
assert!("dora".parse::<NodeId>().is_err());     // reserved for built-in inputs
assert!("dora-node".parse::<NodeId>().is_ok()); // only the exact id is reserved

The infallible-looking conversion panics on the same invalid input:

use dora_message::id::NodeId;
let _ = NodeId::from("node/out".to_string()); // panics — prefer .parse()

Trait Implementations

impl AsRef<str> for NodeId

fn as_ref(&self) -> &str

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

impl Clone for NodeId

fn clone(&self) -> NodeId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NodeId

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

Formats the value using the given formatter.

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

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for NodeId

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

Formats the value using the given formatter.

impl Eq for NodeId

impl From<String> for NodeId

Panics

Panics if id is not a valid node id: if it is empty, contains characters outside [a-zA-Z0-9_.-], starts with ., or is the reserved id dora. Pre-validating against the character set alone is not sufficient to make this conversion infallible.

For untrusted input, use id.parse::<NodeId>() which calls FromStr::from_str and returns Result<Self, InvalidId>.

Do NOT use NodeId::try_from(s): TryFrom<String> is the auto-derived blanket impl that delegates to this From impl, so it panics exactly like .into(). Only parse::<NodeId>() / from_str is fallible.

fn from(id: String) -> Self

Converts to this type from the input type.

impl FromStr for NodeId

type Err = InvalidId

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 NodeId

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 JsonSchema for NodeId

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Ord for NodeId

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

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.

impl PartialEq for NodeId

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for NodeId

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for NodeId