Skip to main content

Context

Struct Context 

Source
pub struct Context {
    pub domain_id: u32,
    pub locator: String,
    pub mode: SessionMode,
    pub rmw: String,
    pub source: ContextSource,
}
Expand description

Phase 212.L.5 — resolved init context.

Returned by every init* entry point. Carries the fields the user needs to construct an ExecutorConfig and open a session.

Fields are owned (String on hosted builds) so the Context can outlive transient parents (env caches, parsed launch files).

Fields§

§domain_id: u32

ROS 2 domain ID (ROS_DOMAIN_ID, default 0).

§locator: String

Middleware locator (NROS_LOCATOR / legacy ZENOH_LOCATOR).

§mode: SessionMode

Session mode (NROS_SESSION_MODE / legacy ZENOH_MODE, default Client).

§rmw: String

RMW implementation hint (RMW_IMPLEMENTATION / NROS_RMW).

Empty when neither var is set. The runtime uses this to pick a primary backend when multiple are linked; see crate::internals::open_session.

§source: ContextSource

Source of this context — useful for diagnostics + tests.

Implementations§

Source§

impl Context

Source

pub fn config<'a>(&'a self, node_name: &'a str) -> ExecutorConfig<'a>

Materialise an ExecutorConfig for a node with the given name.

The returned config borrows from self, so callers usually do:

let ctx = nros::init()?;
let cfg = ctx.config("talker");
let mut executor = nros::Executor::open(&cfg)?;

Trait Implementations§

Source§

impl Clone for Context

Source§

fn clone(&self) -> Context

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 Debug for Context

Source§

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

Formats the value using the given formatter. 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.