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: RelayTopicsFieldWhich of this node’s published topics should be relayed to the dashboard.
topics: TopicsPer-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
impl Clone for NodeConfigBase
Source§impl Debug for NodeConfigBase
impl Debug for NodeConfigBase
Source§impl Default for NodeConfigBase
impl Default for NodeConfigBase
Source§impl<'de> Deserialize<'de> for NodeConfigBase
impl<'de> Deserialize<'de> for NodeConfigBase
Source§fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where
D: Deserializer<'de>,
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
impl JsonSchema for NodeConfigBase
Source§fn schema_id() -> Cow<'static, str>
fn schema_id() -> Cow<'static, str>
Source§fn json_schema(generator: &mut SchemaGenerator) -> Schema
fn json_schema(generator: &mut SchemaGenerator) -> Schema
Source§fn inline_schema() -> bool
fn inline_schema() -> bool
$ref keyword. Read moreSource§impl PartialEq for NodeConfigBase
impl PartialEq for NodeConfigBase
Source§impl Serialize for NodeConfigBase
impl Serialize for NodeConfigBase
impl StructuralPartialEq for NodeConfigBase
Auto Trait Implementations§
impl Freeze for NodeConfigBase
impl RefUnwindSafe for NodeConfigBase
impl Send for NodeConfigBase
impl Sync for NodeConfigBase
impl Unpin for NodeConfigBase
impl UnsafeUnpin for NodeConfigBase
impl UnwindSafe for NodeConfigBase
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> DeserializeOwned for Twhere
T: for<'de> Deserialize<'de>,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
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