Trait ContractBody

Source

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

    const NAME: &'static str;
    const VERSION: &'static str;
    const CONTRACT: &'static str;
    const TOPIC: &'static str;
    const ROLE: TopicRole;
}

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 API version (D60), implemented only by the zero-variant enum Api {} that phoxal_api_tree! generates inside each revision module; its ID is the concrete dotted wire identity (for example "v0.1").
ContractBody is a version-local wire body (D61): a plain serde type bound to exactly one ApiVersion and one contract topic. Every body declared inside a phoxal_api_tree! node gets a generated impl; handles, SetupContext builders, and the Service/Driver derive assertions key off its Api/TOPIC. TOPIC is version-qualified (D1) and is the compatibility key; its serde encoding is the wire payload, with no version envelope (D62). A version-local wire body: a plain serde type bound to exactly one ApiVersion and one contract topic (D61/D1).

Every body declared inside a phoxal_api_tree! node gets a generated impl. Each body carries its own Api version marker and version-qualified TOPIC. Participant setup builders accept these bodies directly and preserve the contract type through each typed handle.

The serde encoding of an implementor is the wire payload; there is no version envelope (D62).

Wire identity is the key, not a hash (D1). The version is folded into TOPIC, so v0.1::drive::Target and a hypothetically re-minted v0.2::drive::Target publish on different Zenoh keys and physically cannot collide. Two participants interoperate on a contract iff they use the exact same version-qualified name, which is realized on the wire by the key. A receiver’s per-key Zenoh subscription is the whole fast-reject; the bus decode path validates only the codec.

Required Associated Constants§

Source

const NAME: &'static str

The version-qualified type identity: the dotted wire revision, then the ::-joined node path (dynamic-node vars are topic params, never type-path segments), then the PascalCase type leaf, e.g. "v0.1::drive::Target" or "v0.1::component::motor::Command". This is the contract’s source identity (D1) - two contracts interoperate iff they share this exact name - as distinct from TOPIC, the resolved wire key derived from it. NAME is exactly the "::"-join of VERSION and CONTRACT; it stays available for callers that want the whole identity as one string (e.g. display), while consumers that must reason about the revision and the contract independently use the two split consts instead - a joined name is not machine-parseable without assuming the version naming scheme.

Source

const VERSION: &'static str

This body’s dotted wire revision alone, e.g. "v0.1" - equal to <Self::Api as ApiVersion>::ID, but exposed directly on the body so a metadata or diagnostics recorder can const-splice it without routing through Self::Api. Split from CONTRACT so a consumer can read the revision without parsing a joined name.

Source

const CONTRACT: &'static str

This body’s contract path within its own version: the ::-joined node path (dynamic-node vars excluded, as with NAME) plus the PascalCase type leaf, e.g. "drive::Target". The logical contract - stable across a version bump - is this value alone; pairing it with VERSION recovers the full version-qualified identity (NAME).

Source

const TOPIC: &'static str

The version-qualified wire key: the dotted wire revision, then the /-joined node path plus the topic leaf, with each dynamic node contributing a {var} placeholder, e.g. "v0.1/drive/state" or "v0.1/component/{instance}/motor/{capability}/command". The concrete key is produced by the api-local topic builder, which fills the placeholders.

Source

const ROLE: TopicRole

The topic role this body was declared with, which fixes both the side brand and the robot time a publisher of it can express.

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 NAME: &'static str

const VERSION: &'static str

const CONTRACT: &'static str

const TOPIC: &'static str

const ROLE: TopicRole

Required Associated Types§

type Api: ApiVersion

Dyn Compatibility§

Implementors§

impl ContractBody for Candidate

const NAME: &'static str = "v0.1::navigation::Candidate"

const VERSION: &'static str = "v0.1"

const CONTRACT: &'static str = "navigation::Candidate"

const TOPIC: &'static str = "v0.1/navigation/candidate"

const ROLE: TopicRole = ::phoxal_bus::TopicRole::State

type Api = Api

impl ContractBody for Chunk

const NAME: &'static str = "v0.1::component::speaker::Chunk"

const VERSION: &'static str = "v0.1"

const CONTRACT: &'static str = "component::speaker::Chunk"

const TOPIC: &'static str = "v0.1/component/{instance}/speaker/{capability}/stream"

const ROLE: TopicRole = ::phoxal_bus::TopicRole::Command

type Api = Api

impl ContractBody for Clock

const NAME: &'static str = "v0.1::simulation::Clock"

const VERSION: &'static str = "v0.1"

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

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

const ROLE: TopicRole = ::phoxal_bus::TopicRole::State

type Api = Api

impl ContractBody for phoxal_api::v0_1::power::Command

const NAME: &'static str = "v0.1::power::Command"

const VERSION: &'static str = "v0.1"

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

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

const ROLE: TopicRole = ::phoxal_bus::TopicRole::Command

type Api = Api

impl ContractBody for phoxal_api::v0_1::behavior::Command

const NAME: &'static str = "v0.1::behavior::Command"

const VERSION: &'static str = "v0.1"

const CONTRACT: &'static str = "behavior::Command"

const TOPIC: &'static str = "v0.1/behavior/command"

const ROLE: TopicRole = ::phoxal_bus::TopicRole::Command

type Api = Api

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

const NAME: &'static str = "v0.1::component::motor::Command"

const VERSION: &'static str = "v0.1"

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

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

const ROLE: TopicRole = ::phoxal_bus::TopicRole::Command

type Api = Api

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

const NAME: &'static str = "v0.1::component::led::Command"

const VERSION: &'static str = "v0.1"

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

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

const ROLE: TopicRole = ::phoxal_bus::TopicRole::Command

type Api = Api

impl ContractBody for Detections

const NAME: &'static str = "v0.1::perception::Detections"

const VERSION: &'static str = "v0.1"

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

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

const ROLE: TopicRole = ::phoxal_bus::TopicRole::State

type Api = Api

impl ContractBody for Devices

const NAME: &'static str = "v0.1::joypad::Devices"

const VERSION: &'static str = "v0.1"

const CONTRACT: &'static str = "joypad::Devices"

const TOPIC: &'static str = "v0.1/joypad/devices"

const ROLE: TopicRole = ::phoxal_bus::TopicRole::Diagnostic

type Api = Api

impl ContractBody for phoxal_api::v0_1::behavior::Event

const NAME: &'static str = "v0.1::behavior::Event"

const VERSION: &'static str = "v0.1"

const CONTRACT: &'static str = "behavior::Event"

const TOPIC: &'static str = "v0.1/behavior/event"

Trait ContractBody