Skip to main content

BootConfig

Struct BootConfig 

Source
pub struct BootConfig<'a> {
    pub node_name: Option<&'a str>,
    pub locator: Option<&'a str>,
    pub domain_id: Option<u32>,
    pub namespace: Option<&'a str>,
}
Expand description

Session-identity subset a caller supplies to ExecutorConfig::resolve.

None on a field means “not specified — fall through to the next precedence level”. The precedence model (A) resolved by ExecutorConfig::resolve is:

env (only if hosted_env && the var is set)
  > baked (a Some field here)
    > compiled default

Fields are resolved independently: an env locator and a baked node_name can both apply in the same call.

Note: mode (session mode) is not configurable through BootConfig. BootConfig carries only node_name, locator, domain_id, and namespace. Session mode falls through to the env-cache default (SessionMode::Client).

Fields§

§node_name: Option<&'a str>

Node name override. Maps to ExecutorConfig::node_name.

§locator: Option<&'a str>

Middleware locator override. Maps to ExecutorConfig::locator.

§domain_id: Option<u32>

ROS 2 domain ID override. Maps to ExecutorConfig::domain_id.

§namespace: Option<&'a str>

Node namespace override. Maps to ExecutorConfig::namespace.

Implementations§

Source§

impl<'a> BootConfig<'a>

Source

pub fn from_baked(baked: &'a BakedBootConfig) -> BootConfig<'a>

Read a baked config into the plain-field BootConfig the resolver consumes.

Returns all-None (→ resolver uses compiled defaults) if magic/version don’t match — defensive against a corrupt or zero-initialised section.

Each Option is Some iff its set_flags bit is set; string values are the bytes up to the first NUL (or full buffer if no NUL). Invalid UTF-8 in a set field is treated as unset for that field.

Trait Implementations§

Source§

impl<'a> Clone for BootConfig<'a>

Source§

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

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<'a> Debug for BootConfig<'a>

Source§

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

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

impl<'a> Default for BootConfig<'a>

Source§

fn default() -> BootConfig<'a>

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

impl<'a> Copy for BootConfig<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for BootConfig<'a>

§

impl<'a> RefUnwindSafe for BootConfig<'a>

§

impl<'a> Send for BootConfig<'a>

§

impl<'a> Sync for BootConfig<'a>

§

impl<'a> Unpin for BootConfig<'a>

§

impl<'a> UnsafeUnpin for BootConfig<'a>

§

impl<'a> UnwindSafe for BootConfig<'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.