Trait ContractBody

Source

pub trait ContractBody:
    Serialize
    + DeserializeOwned
    + Clone
    + Send
    + Sync
    + 'static {
    type Api: ApiVersion;

    const FAMILY: &'static str;
    const TOPIC: &'static str;
}

Expand description

The contract primitive traits, re-exported from the phoxal-bus crate (the ABI floor) so they stay addressable at phoxal_api::ApiVersion / phoxal_api::ContractBody.

ApiVersion is the marker trait identifying one dated API version (D60), implemented only by the zero-variant enum Api {} that phoxal_api_tree! generates inside each version module; its ID is the dated module name ("y2026_1") and the canonical version identity, carried in bus metadata.
ContractBody is a version-local wire body (D61): a plain serde type bound to exactly one ApiVersion and one contract family/topic. Every body declared inside a phoxal_api_tree! node gets a generated impl; handles, SetupContext builders, and the #[derive(Runtime)] assertions key off its Api/FAMILY/TOPIC to reject a body from the wrong API version at compile time. Its serde encoding is the wire payload; there is no version envelope (D62). A version-local wire body: a plain serde type bound to exactly one ApiVersion and one contract family/topic (D61).

Every body declared inside a phoxal_api_tree! node gets a generated impl. Handles, SetupContext builders, and the #[derive(Runtime)] assertions all key off Api/FAMILY/TOPIC, which is how a body from the wrong API version is rejected at compile time.

The serde encoding of an implementor is the wire payload; there is no version envelope (D62). Version and family travel as bus metadata, derived from Api and FAMILY.

Required Associated Constants§

Source

const FAMILY: &'static str

Canonical contract family id: the ::-joined node path plus the body type name, with dynamic variables excluded, e.g. "drive::State" or "component::motor::Command".

Source

const TOPIC: &'static str

Versionless topic key: the /-joined node path plus the topic leaf, with each dynamic node contributing a {var} placeholder, e.g. "drive/state" or "component/{instance}/motor/{capability}/command". The runtime key is produced by the api-local topic builder, which fills the placeholders.

Required Associated Types§

Source

type Api: ApiVersion

The single API version this body belongs to. Two bodies from different versions have different Api, so the type system keeps them apart.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

ContractBody

Trait ContractBody Copy item path

Required Associated Constants§

const FAMILY: &'static str

const TOPIC: &'static str

Required Associated Types§

type Api: ApiVersion

Dyn Compatibility§

Implementors§

impl ContractBody for Clock

const FAMILY: &'static str = "simulation::Clock"

const TOPIC: &'static str = "simulation/clock"

type Api = Api

impl ContractBody for phoxal_api::y2026_1::mission::Command

const FAMILY: &'static str = "mission::Command"

const TOPIC: &'static str = "mission/command"

type Api = Api

impl ContractBody for phoxal_api::y2026_1::power::Command

const FAMILY: &'static str = "power::Command"

const TOPIC: &'static str = "power/command"

type Api = Api

impl ContractBody for phoxal_api::y2026_1::component::motor::Command

const FAMILY: &'static str = "component::motor::Command"

const TOPIC: &'static str = "component/{instance}/motor/{capability}/command"

type Api = Api

impl ContractBody for phoxal_api::y2026_1::component::led::Command

const FAMILY: &'static str = "component::led::Command"

const TOPIC: &'static str = "component/{instance}/led/{capability}/command"

type Api = Api

impl ContractBody for Contact

const FAMILY: &'static str = "simulation::Contact"

const TOPIC: &'static str = "simulation/contact"

type Api = Api

impl ContractBody for Control

const FAMILY: &'static str = "simulation::Control"

const TOPIC: &'static str = "simulation/control"

type Api = Api

impl ContractBody for Detections

const FAMILY: &'static str = "perception::Detections"

const TOPIC: &'static str = "perception/detections"

type Api = Api

impl ContractBody for EmergencyStopRequest

const FAMILY: &'static str = "safety::EmergencyStopRequest"

const TOPIC: &'static str = "safety/estop"

type Api = Api

impl ContractBody for phoxal_api::y2026_1::component::camera::Frame

const FAMILY: &'static str = "component::camera::Frame"

const TOPIC: &'static str = "component/{instance}/camera/{capability}/frame"

type Api = Api

impl ContractBody for phoxal_api::y2026_1::component::depth::Frame

const FAMILY: &'static str = "component::depth::Frame"

const TOPIC: &'static str = "component/{instance}/depth/{capability}/frame"

type Api = Api

impl ContractBody for phoxal_api::y2026_1::component::microphone::Frame

const FAMILY: &'static str = "component::microphone::Frame"

const TOPIC: &'static str = "component/{instance}/microphone/{capability}/frame"

type Api = Api

impl ContractBody for Frontiers

const FAMILY: &'static str = "explore::Frontiers"

const TOPIC: &'static str = "explore/frontiers"

type Api = Api

impl ContractBody for GetRequest

const FAMILY: &'static str = "asset::GetRequest"

const TOPIC: &'static str = "asset/get"

type Api = Api

impl ContractBody for GetResponse

const FAMILY: &'static str = "asset::GetResponse"

const TOPIC: &'static str = "asset/get"

type Api = Api

impl ContractBody for Goal

const FAMILY: &'static str = "mission::Goal"

const TOPIC: &'static str = "mission/goal"

type Api = Api

impl ContractBody for Heartbeat

const FAMILY: &'static str = "presence::Heartbeat"

const TOPIC: &'static str = "presence/heartbeat"

type Api = Api

impl ContractBody for JointState

const FAMILY: &'static str = "joint::JointState"

const TOPIC: &'static str = "joint/{joint}/state"

Trait ContractBody