Struct ActionSpec 

pub struct ActionSpec {
    pub name: &'static str,
    pub description: &'static str,
    pub required_scope: Option<&'static str>,
    pub transport: ActionTransport,
    pub rest_method: Option<&'static str>,
    pub rest_path: Option<&'static str>,
    pub destructive: bool,
    pub requires_admin: bool,
    pub cost: ActionCost,
    pub params: &'static [ParamSpec],
    pub returns: &'static str,
    pub cli: Option<CliSpec>,
}

Canonical, invariant metadata for a single Soma action.

Fields

name: &'static str

Action name (the action dispatch key).

description: &'static str

Human-readable description of what the action does.

required_scope: Option<&'static str>

Scope required to invoke the action, or None if public.

transport: ActionTransport

Transports the action is reachable over.

rest_method: Option<&'static str>

REST method for the action’s direct route, if any.

rest_path: Option<&'static str>

REST path for the action’s direct route, if any.

destructive: bool

Whether the action is destructive and requires confirmation.

requires_admin: bool

Whether the action requires admin privileges.

cost: ActionCost

Advertised cost / side-effect tier.

params: &'static [ParamSpec]

Parameter specifications.

returns: &'static str

Name of the returned result type.

cli: Option<CliSpec>

CLI surface for the action, if it has one.

Trait Implementations

impl Clone for ActionSpec

fn clone(&self) -> ActionSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ActionSpec

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

Formats the value using the given formatter.

impl PartialEq for ActionSpec

fn eq(&self, other: &ActionSpec) -> 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 Copy for ActionSpec

impl Eq for ActionSpec

impl StructuralPartialEq for ActionSpec