Struct ActionSpec 

pub struct ActionSpec {
    pub name: &'static str,
    pub description: &'static str,
    pub input: &'static Schema,
    pub output: &'static Schema,
    pub capabilities: u64,
    pub mutation: bool,
    pub revision_required: bool,
    pub undo: bool,
    pub transaction: Option<&'static str>,
    pub cancellable: bool,
    pub command_id: Option<u32>,
    pub access: Access,
}

A static semantic action contract. Register each implementation once in its host.

Fields

name: &'static str

Stable, language-independent identifier, e.g. document.text.replace.

description: &'static str

Description for human and automated discovery.

input: &'static Schema

Validated input schema.

output: &'static Schema

Validated completed-result schema.

capabilities: u64

Bit set of platform services required by this action; defined by the platform layer.

mutation: bool

Whether the action can change application or document state.

revision_required: bool

Require an expected revision for external mutation calls.

undo: bool

Whether the operation is integrated with the application’s undo history.

transaction: Option<&'static str>

Transaction domain, or None when atomic batches are unsupported.

cancellable: bool

Whether the operation can return a cancellable task.

command_id: Option<u32>

Optional compatible numeric GUI command identifier.

access: Access

Who may run it through external control; hosts may tighten it (Host::access).

Implementations

impl ActionSpec

pub const fn read(name: &'static str, description: &'static str) -> Self

Parameterless read action with a general structured-object result.

pub const fn confirm(self) -> Self

External calls need the user’s confirmation first.

pub const fn local_only(self) -> Self

Only trusted in-process GUI calls; external control is refused.

pub const fn write(name: &'static str, description: &'static str) -> Self

Revision-checked mutation; the caller can set undo and transaction metadata.

pub const fn schemas( self, input: &'static Schema, output: &'static Schema, ) -> Self

Replace both schemas while preserving other metadata.

Trait Implementations

impl Clone for ActionSpec

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ActionSpec

impl Debug for ActionSpec

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

Formats the value using the given formatter.