Skip to main content

DeclareCapabilityRequest

Struct DeclareCapabilityRequest 

Source
pub struct DeclareCapabilityRequest {
    pub provider_id: String,
    pub contract_id: String,
    pub transport: i32,
    pub endpoint: String,
    pub params: Option<TransportParams>,
    pub description: String,
}

Fields§

§provider_id: String

Owning CapabilityProvider (primitive/service/skill); MUST already be registered.

§contract_id: String

contract_id, e.g. “robonix/primitive/camera/depth”.

§transport: i32§endpoint: String

Preferred address string. Format is transport-specific: grpc: “127.0.0.1:50105” (caller binds first) ros2: “/scanner/cloud” (“” => Atlas mints) mcp: “http://host:port/mcp"

Conflict resolution:

  • empty proposal + mintable transport (ros2) -> Atlas mints /rbnx/<dotted-contract>/<uuid8>
  • empty proposal + non-mintable transport (grpc, mcp) -> InvalidArgument
  • non-empty + no collision -> stored verbatim
  • non-empty + collision + mintable -> Atlas rewrites by appending __<uuid8>
  • non-empty + collision + non-mintable -> AlreadyExists (caller picks new and retries)

CALLER MUST USE the returned endpoint.

§params: Option<TransportParams>

Transport-specific params; the oneof variant MUST match transport.

§description: String

Instance-specific natural-language description for THIS particular Capability instance – the part that’s specific to this provider’s setup, on top of whatever the contract already says generically. Example: contract robonix/primitive/camera/rgb already explains “returns current RGB image as sensor_msgs/Image”; this field adds “front-facing, 640x480 @ 30 Hz, no exposure compensation” for the front_camera instance specifically. Surfaced to Pilot / LLM.

Filled by the CapabilityProvider – either explicitly, or auto- filled by the framework from the handler’s docstring (e.g. robonix_api’s @cap.mcp(...) / @cap.grpc(...) wrappers read the wrapped function’s docstring into this field before calling DeclareCapability). Either way, only this single field hits the wire.

SHOULD be one short line (~200 chars or less); longer prose belongs in CAPABILITY.md.

Optional; may be empty when the contract’s description already says everything that needs saying. Consumers MERGE this with ContractDescriptor.description at consume time – the two are not alternatives; they cover generic vs instance-specific aspects of the same Capability and may overlap. The CapabilityProvider’s CAPABILITY.md is a separate, long-form per-CapabilityProvider doc (see RegisterRequest.capability_md_path), surfaced alongside.

Implementations§

Source§

impl DeclareCapabilityRequest

Source

pub fn transport(&self) -> Transport

Returns the enum value of transport, or the default if the field is set to an invalid enum value.

Source

pub fn set_transport(&mut self, value: Transport)

Sets transport to the provided enum value.

Trait Implementations§

Source§

impl Clone for DeclareCapabilityRequest

Source§

fn clone(&self) -> DeclareCapabilityRequest

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 DeclareCapabilityRequest

Source§

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

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

impl Default for DeclareCapabilityRequest

Source§

fn default() -> Self

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

impl Eq for DeclareCapabilityRequest

Source§

impl Hash for DeclareCapabilityRequest

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Message for DeclareCapabilityRequest

Source§

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.
Source§

fn clear(&mut self)

Clears the message, resetting all fields to their default.
Source§

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>
where Self: Sized,

Encodes the message to a buffer. Read more
Source§

fn encode_to_vec(&self) -> Vec<u8>
where Self: Sized,

Encodes the message to a newly allocated buffer.
Source§

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>
where Self: Sized,

Encodes the message with a length-delimiter to a buffer. Read more
Source§

fn encode_length_delimited_to_vec(&self) -> Vec<u8>
where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.
Source§

fn decode(buf: impl Buf) -> Result<Self, DecodeError>
where Self: Default,

Decodes an instance of the message from a buffer. Read more
Source§

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>
where Self: Default,

Decodes a length-delimited instance of the message from the buffer.
Source§

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>
where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self. Read more
Source§

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>
where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.
Source§

impl PartialEq for DeclareCapabilityRequest

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for DeclareCapabilityRequest

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
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

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

§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
§

impl<T> Instrument for T

§

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

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

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.

§

impl<T> IntoRequest<T> for T

§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
§

impl<L> LayerExt<L> for L

§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in [Layered].
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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