Skip to main content

NodeConfigBase

Struct NodeConfigBase 

Source
pub struct NodeConfigBase {
    pub relay: RelayTopicsField,
    pub topics: Topics,
    pub model: Option<NodeModelConfig>,
    pub task: Option<String>,
    pub status_rate_hz: Option<f32>,
    pub controller: Option<Value>,
    pub orientation: Option<Value>,
}
Expand description

Fields common to every node’s configuration, reserved across all node types.

Fields§

§relay: RelayTopicsField

Which of this node’s published topics should be relayed to the dashboard.

§topics: Topics

Per-role publish/subscribe topic configuration - every built-in node declares one of these.

§model: Option<NodeModelConfig>

Which model this node should load, for the nodes that have this concept (object-detector, image-classifier, rl, llm-command - the latter via its name/provider fields only, see the module docs). None for every other node, and for these four when the key is simply absent - see the module docs for why this is never a node-specific default value.

§task: Option<String>

The task this node implements, if any (e.g. a trained imitation-learning policy’s task name) - self-reported over this node’s /system/health heartbeat so the dashboard can show which tasks currently have a live node without a separate request/response protocol. None for nodes that don’t implement a specific task.

§status_rate_hz: Option<f32>

How often, in Hz, to publish node status updates, for the nodes that have this concept (camera, motor, teleop). None for every other node, and for these three when the key is simply absent - see the module docs for why this is never a node-specific default value.

§controller: Option<Value>

The mock-vs-hardware controller backend selector, for the nodes that have this concept (imu, motor). Opaque - see the module docs for why this can’t be a shared Rust type the way model/topics are.

§orientation: Option<Value>

Physical-mounting orientation correction, for the nodes that have this concept (camera, servo, pan-tilt). Opaque - see the module docs for why this can’t be a shared Rust type the way model/topics are.

Trait Implementations§

Source§

impl Clone for NodeConfigBase

Source§

fn clone(&self) -> Self

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

Source§

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

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

impl Default for NodeConfigBase

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for NodeConfigBase

Source§

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where D: Deserializer<'de>,

Deserializes via [NodeConfigBaseShadow] - a plain struct with no #[serde(flatten)] fields of its own - rather than a derived #[serde(flatten)] relay: RelayTopicsField field, which would be a second, nested level of flatten once this struct is itself flattened into a node’s own #[serde(deny_unknown_fields)] config struct (the only way this type is ever used - see the struct doc comment). Nested flatten defeats deny_unknown_fields: the outer struct’s generated code can no longer tell a genuine typo (e.g. behaviour_name) from a field this type legitimately owns, and silently accepts both. Every field this struct declares - relay_topics, topics, model, task, status_rate_hz, controller - is already a plain top-level JSON key by name, so the shadow struct can read them all as ordinary named fields with no flatten needed anywhere.

Source§

impl JsonSchema for NodeConfigBase

Source§

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

The name of the generated JSON Schema. Read more
Source§

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

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

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

Generates a JSON Schema for this type. Read more
Source§

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. Read more
Source§

impl PartialEq for NodeConfigBase

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for NodeConfigBase

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for NodeConfigBase

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more