Skip to main content

RmwConfig

Struct RmwConfig 

Source
pub struct RmwConfig<'a> {
    pub locator: &'a str,
    pub mode: SessionMode,
    pub domain_id: u32,
    pub node_name: &'a str,
    pub namespace: &'a str,
    pub properties: &'a [(&'a str, &'a str)],
}
Expand description

Middleware-agnostic session configuration.

RmwConfig provides a uniform interface that any RMW backend can interpret. Backends map the universal fields to their own connection parameters and interpret properties for anything backend-specific.

§Examples

use nros_rmw::{RmwConfig, SessionMode};

let config = RmwConfig {
    locator: "tcp/192.168.1.1:7447",
    mode: SessionMode::Client,
    domain_id: 0,
    node_name: "talker",
    namespace: "",
    properties: &[],
};

Fields§

§locator: &'a str

Middleware-specific connection string.

  • zenoh: "tcp/192.168.1.1:7447" or "udp/224.0.0.224:7447"
  • XRCE-DDS: "udp/192.168.1.1:2019"
§mode: SessionMode

Session mode (zenoh: client/peer; XRCE-DDS: always client)

§domain_id: u32

ROS 2 domain ID (maps to DDS domain or zenoh key prefix)

§node_name: &'a str

Node name (e.g., "talker")

§namespace: &'a str

Node namespace (e.g., "" or "/ns1")

§properties: &'a [(&'a str, &'a str)]

Backend-specific key/value properties.

Uniform escape hatch for backend-specific tuning that doesn’t fit the universal fields above. Each backend documents the keys it understands; unknown keys are ignored. Passing &[] is always valid.

Examples:

  • zenoh: "tls.root_ca", "scouting.multicast.enabled"
  • XRCE-DDS: "agent_port", "client_key"

Trait Implementations§

Source§

impl<'a> Clone for RmwConfig<'a>

Source§

fn clone(&self) -> RmwConfig<'a>

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

impl<'a> Debug for RmwConfig<'a>

Source§

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

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

impl Default for RmwConfig<'_>

Source§

fn default() -> RmwConfig<'_>

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

impl<'a> Copy for RmwConfig<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for RmwConfig<'a>

§

impl<'a> RefUnwindSafe for RmwConfig<'a>

§

impl<'a> Send for RmwConfig<'a>

§

impl<'a> Sync for RmwConfig<'a>

§

impl<'a> Unpin for RmwConfig<'a>

§

impl<'a> UnsafeUnpin for RmwConfig<'a>

§

impl<'a> UnwindSafe for RmwConfig<'a>

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.