Skip to main content

SurfaceDescriptor

Struct SurfaceDescriptor 

Source
pub struct SurfaceDescriptor {
    pub id: String,
    pub symbol: Symbol,
    pub title: String,
    pub description: String,
    pub input_shape: Value,
    pub output_shape: Option<Value>,
    pub roles: Vec<Symbol>,
    pub capabilities: Vec<Symbol>,
    pub annotations: Vec<(String, String)>,
}
Expand description

Plain-data spine describing a surface (a callable projected onto a foreign tool surface). Depends only on kernel types; concrete codecs render it.

Fields§

§id: String

Stable surface id (for example a skill id).

§symbol: Symbol

Kernel symbol that names the underlying callable.

§title: String

Human-facing title.

§description: String

Human-facing description.

§input_shape: Value

Shape describing accepted input.

§output_shape: Option<Value>

Shape describing produced output, when known.

§roles: Vec<Symbol>

Roles this surface is published under.

§capabilities: Vec<Symbol>

Capabilities the surface requires.

§annotations: Vec<(String, String)>

Free-form (key, value) annotations.

Implementations§

Source§

impl SurfaceDescriptor

Source

pub fn external_name(&self, policy: ExternalNamePolicy) -> String

Project this surface’s symbol onto an external name under policy.

Trait Implementations§

Source§

impl Clone for SurfaceDescriptor

Source§

fn clone(&self) -> SurfaceDescriptor

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 SurfaceDescriptor

Source§

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

Formats the value using the given formatter. Read more

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

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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.

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.