Struct ActionParam 

pub struct ActionParam {
    pub name: Cow<'static, str>,
    pub ty: ParamType,
    pub required: bool,
    pub description: Cow<'static, str>,
    pub choices: Vec<Cow<'static, str>>,
    pub schema: Option<Arc<Value>>,
    pub nullable: bool,
}

One typed parameter an action declares.

Fields

name: Cow<'static, str>

ty: ParamType

required: bool

Whether an invocation must supply it. An optional parameter’s default belongs to the action and is stated in description — the surface does not invent one.

description: Cow<'static, str>

choices: Vec<Cow<'static, str>>

When non-empty, the only values this parameter accepts.

This is what turns a prose list ("grayscale / sepia / invert") into something a caller can read and something ActionArgs::bind can enforce. A value outside the set is refused by name rather than quietly falling through to a default.

schema: Option<Arc<Value>>

JSON Schema fragment applied after the basic type check. This carries ranges, lengths, patterns, formats, item/object schemas, and defaults without growing a second incompatible validation vocabulary.

nullable: bool

Explicitly permits JSON null. Optional means omitted; nullable means present with no value, and callers need to distinguish the two.

Implementations

impl ActionParam

pub const fn required( name: &'static str, ty: ParamType, description: &'static str, ) -> ActionParam

A required parameter with static strings — usable in a const.

pub const fn optional( name: &'static str, ty: ParamType, description: &'static str, ) -> ActionParam

An optional parameter with static strings — usable in a const.

pub fn required_owned( name: impl Into<Cow<'static, str>>, ty: ParamType, description: impl Into<Cow<'static, str>>, ) -> ActionParam

A required parameter whose strings are built at runtime — what an app declaring parameters out of live document state needs.

pub fn optional_owned( name: impl Into<Cow<'static, str>>, ty: ParamType, description: impl Into<Cow<'static, str>>, ) -> ActionParam

An optional parameter whose strings are built at runtime.

pub fn with_choices<S>( self, choices: impl IntoIterator<Item = S>, ) -> ActionParam

where S: Into<Cow<'static, str>>,

Restrict this parameter to choices. Binding refuses anything else.

pub fn with_schema(self, schema: Value) -> ActionParam

pub fn with_shared_schema(self, schema: Arc<Value>) -> ActionParam

Retain an immutable schema already shared by the current type generation. Wire serialization and strict argument validation are unchanged.

pub fn of_resource_kind(self, kind: impl Into<String>) -> ActionParam

Name the kind of resource this ParamType::Resource parameter takes (e.g. files.entry), as the RESOURCE_KIND_ANNOTATION of its schema. Surfaces use it to offer the action on resources of that kind and its sub-kinds.

pub fn resource_kind(&self) -> Option<&str>

The kind of resource this parameter takes, when it is a resource parameter that names one (Self::of_resource_kind).

pub fn as_place(self) -> ActionParam

Make this a place inside the resource the action is on: an object naming one of its items ({"item": id}), a caret in it ({"item": id, "at": n}) or a range of it ({"item": id, "start": n, "end": n}). Marked with the PLACE_ANNOTATION, so a palette or an agent offers the resource’s items rather than free text. An action given one acts there instead of at the invoker’s caret.

pub fn as_place_in(self, field: &str) -> ActionParam

Self::as_place, its items being those of the collection field (a document’s paragraphs, blocks): the item resources published as <resource>/<field>/<item>.

pub fn as_content(self) -> ActionParam

Make this text parameter the address of content another action produced: a caller chains it from that action’s result, never from words (marked with the CONTENT_ANNOTATION).

pub fn is_content(&self) -> bool

Whether this parameter takes content another action produced (Self::as_content).

pub fn is_place(&self) -> bool

Whether this parameter is a place inside the resource (Self::as_place).

pub fn place_field(&self) -> Option<&str>

The collection whose items this place parameter names, when it says (Self::as_place_in).

pub fn nullable(self) -> ActionParam

pub fn validate_declaration(&self) -> Vec<String>

Validate this parameter’s descriptor independently of any supplied value, suitable for an untrusted publication boundary.

Trait Implementations

impl Clone for ActionParam

fn clone(&self) -> ActionParam

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ActionParam

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ActionParam

fn deserialize<__D>( __deserializer: __D, ) -> Result<ActionParam, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ActionParam

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ActionParam

impl StructuralPartialEq for ActionParam