Struct CapabilityDocument 

pub struct CapabilityDocument {
    pub protocol_version: String,
    pub profiles: Vec<String>,
    pub features: BTreeMap<String, bool>,
    pub limits: BTreeMap<String, u64>,
}

A deployment’s self-description (API spec, “Capability discovery”).

A remote client fetches this from GET /v0/capabilities and caches it; an embedded engine exposes the same document as a constant. SDK gating logic is therefore identical for both backends: check supports or has_profile, and treat a not_supported error as authoritative when the two disagree.

Fields

protocol_version: String

The protocol generation, currently v0.

profiles: Vec<String>

Advertised profiles, each plane/version. All-or-nothing: every required op of an advertised profile is implemented.

features: BTreeMap<String, bool>

Named features and whether this deployment supports them. An absent key means unsupported.

limits: BTreeMap<String, u64>

Advisory numeric limits clients may use to pre-validate requests.

Implementations

impl CapabilityDocument

pub fn has_profile(&self, profile: &str) -> bool

Whether a profile (for example core/v0) is advertised.

pub fn supports(&self, feature: &str) -> bool

Whether a feature is advertised as supported. Absent keys are unsupported.

pub fn validate(&self) -> Result<(), CapabilityDocumentError>

Checks the feature-key rule (API spec, “Capability discovery”): every feature key’s first dotted segment must be the plane name of an advertised profile.

pub fn retain_well_formed(&mut self)

Drops feature keys that violate the feature-key rule, the client-side “ignore” handling for malformed documents.

Trait Implementations

impl Clone for CapabilityDocument

fn clone(&self) -> CapabilityDocument

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CapabilityDocument

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CapabilityDocument

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for CapabilityDocument

impl PartialEq for CapabilityDocument

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for CapabilityDocument

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CapabilityDocument