Struct NodeKey 

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

Which node a parameter belongs to.

phase-426 W1 — upstream’s parameters belong to a NODE, not to a process: ros2 param list enumerates per node and /<node>/get_parameters is a per-node service. An image composes several nodes onto one executor (RFC-0047), so a store with no node key makes /talker’s rate and /listener’s rate the same parameter.

The key is the executor’s node INDEX, not a name: nros_node::NodeId is already a u8 index into the executor’s node table, it is already the identity the FFI persists (rcl_node_t.node_id, nros_cpp_node_t.node_id), and one byte per slot keeps the store’s arena the size it was. A name would cost MAX_PARAM_NAME_LEN bytes per slot and would need a second answer to “which node is this” that could disagree with the table.

nros-params sits below nros-node, so this is the local spelling and nros-node converts (impl From<NodeId> for NodeKey).

Implementations

impl NodeKey

pub const PRIMARY: NodeKey

The executor’s implicit primary node — nros_node::NodeId::PRIMARY.

pub const fn new(index: u8) -> Self

Build a key from a node table index.

pub const fn index(self) -> usize

The node table index this key names.

pub const fn raw(self) -> u8

The raw index, for FFI persistence.

Trait Implementations

impl Clone for NodeKey

fn clone(&self) -> NodeKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for NodeKey

impl Debug for NodeKey

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

Formats the value using the given formatter.

impl Default for NodeKey

fn default() -> NodeKey

Returns the “default value” for a type.

impl Eq for NodeKey

impl Hash for NodeKey

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 Ord for NodeKey

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for NodeKey

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