Struct CanvasDeclaration 

#[non_exhaustive]
pub struct CanvasDeclaration {
    pub id: String,
    pub display_name: String,
    pub description: String,
    pub input_schema: Option<Value>,
    pub actions: Option<Vec<CanvasAction>>,
}

Declarative metadata for a single canvas, sent over the wire on session.create / session.resume.

Experimental. This type is part of an experimental wire-protocol surface and may change or be removed in future SDK or CLI releases.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: String

Canvas identifier, unique within the declaring connection.

display_name: String

Human-readable name shown in host UI and canvas pickers.

description: String

Short, single-sentence description shown to the agent in canvas catalogs.

input_schema: Option<Value>

JSON Schema for the input payload accepted by canvas.open.

actions: Option<Vec<CanvasAction>>

Agent-callable actions this canvas exposes.

Implementations

impl CanvasDeclaration

pub fn new( id: impl Into<String>, display_name: impl Into<String>, description: impl Into<String>, ) -> Self

Construct a canvas declaration with the required fields set.

pub fn with_description(self, description: impl Into<String>) -> Self

Set the description surfaced in discovery and agent context.

Trait Implementations

impl Clone for CanvasDeclaration

fn clone(&self) -> CanvasDeclaration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CanvasDeclaration

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

Formats the value using the given formatter.

impl Default for CanvasDeclaration

fn default() -> CanvasDeclaration

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CanvasDeclaration

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CanvasDeclaration

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

where __S: Serializer,

Serialize this value into the given Serde serializer.