Struct Shell 

pub struct Shell {

    pub spawn: String,
    pub ephemeral: bool,
    pub broadcast: Option<Broadcast>,
    pub command_receipt: Option<CommandReceipt>,
    pub pre_close: Option<String>,
    pub close_timeout_ms: Option<u64>,
    pub persistent: bool,
    pub wake_command: Option<String>,
    pub can_shutdown: bool,
    pub require_approval: ShellApproval,
    pub max_instances_per_owner: Option<u32>,
    pub over_cap: OverCap,
    pub capabilities: BTreeMap<String, ShellCapability>,
    pub sensory: Sensory,
    pub drive: Drive,
    pub tunnel: Tunnel,
}

[shell] — the body of a kind = "shell" adapter (a driven surface).

Fields

spawn: String

Broker-launched opaque spawn command.

ephemeral: bool

Ephemeral ⇒ no offline perch + no history retention.

broadcast: Option<Broadcast>

command_receipt: Option<CommandReceipt>

How the shell receives agent commands.

pre_close: Option<String>

Instruction sent to the binary on link-break.

close_timeout_ms: Option<u64>

Graceful-termination window before force-close.

persistent: bool

Auto-online whenever the owner endpoint is online.

wake_command: Option<String>

Long-running wake-watcher run WHILE offline; exit ⇒ revive.

can_shutdown: bool

Whether the shell may fire api owner-shutdown to suspend its owner.

require_approval: ShellApproval

Per-spawn user approval gate (floor; a node/endpoint setting may tighten). Absent ⇒ none. (Modeled now; conducted when shells land.)

max_instances_per_owner: Option<u32>

Optional ceiling on concurrent-existing instances per owner endpoint (online + offline both count). Absent ⇒ unlimited.

over_cap: OverCap

What happens at the cap: reject (default) or approve (per-spawn approval beyond the cap; does not raise it). Only meaningful with a cap.

capabilities: BTreeMap<String, ShellCapability>

[shell.capabilities] — the command vocabulary (agent→shell).

sensory: Sensory

[shell.sensory] — the sensory vocabulary (shell→agent).

drive: Drive

[shell.drive] — the drive vocabulary (agent→shell, REST-only ephemeral control; M11-W2, REQ-SHELL-3). The owner→shell mirror of [shell.sensory].

tunnel: Tunnel

[shell.tunnel] — opt-in for the opaque reliable-ordered byte tunnel (M11-W3, REQ-SHELL-4). Absent ⇒ no tunnel.

Trait Implementations

impl Clone for Shell

fn clone(&self) -> Shell

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Shell

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Shell

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for Shell

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for Shell

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Shell

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 Shell