Struct ArgumentSpec 

#[non_exhaustive]
pub struct ArgumentSpec {
    pub name: String,
    pub description: Option<String>,
    pub labels: Vec<ArgumentLabel>,
    pub required: bool,
    pub source: ArgumentSource,
    pub shape: ValueShape,
    pub names_the_record: bool,
}

One argument of an operation.

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.

name: String

Its name among the arguments’ top-level fields.

description: Option<String>

What it is, from the argument type’s documentation unless replaced.

labels: Vec<ArgumentLabel>

The words people use for it. Hints for the model, never matched by code.

required: bool

Whether an act cannot run without it.

source: ArgumentSource

Where its value comes from.

shape: ValueShape

The shape a model gives its value.

names_the_record: bool

Whether its value names the record the operation creates, for the acts of the same turn that point at that record before it has a label.

Implementations

impl ArgumentSpec

pub fn new(name: impl Into<String>, shape: ValueShape) -> Self

An argument named name of shape, user-sourced and optional.

pub fn label(self, text: impl Into<String>) -> Self

Adds a word people use for it, in every language.

pub fn label_in( self, locale: impl Into<Locale>, text: impl Into<String>, ) -> Self

Adds a word people use for it in locale.

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

Replaces its description.

pub const fn required(self) -> Self

Makes it required.

pub const fn names_the_record(self) -> Self

Says its value names the record the operation creates.

pub const fn optional(self) -> Self

Makes it optional.

pub fn inferred(self) -> Self

Lets the model deduce it from what the user said.

pub fn from_read(self, read: impl Into<ReadToolKey>) -> Self

Fills it from read after the plan exists.

pub fn written(self) -> Self

Lets the model phrase a text value instead of selecting the user’s words.

pub fn date_direction(self, direction: DateDirection) -> Self

Points a date without a year in direction.

pub fn money(self) -> Self

Gives it as an amount of money.

pub fn record(self, workflow: impl Into<WorkflowKey>) -> Self

Gives it as a record of workflow. The operation receives the record’s CaseRef fields, with label when the record was in view, or, for one the same turn opens, the value of the opening operation’s argument that names it. A record named but not in view is looked up in the case directory, and asked for again when none or several match.

pub fn labels_for<'a>( &'a self, locale: &'a Locale, ) -> impl Iterator<Item = &'a str> + 'a

The labels that apply in locale: its own ones first, then the universal ones.

Trait Implementations

impl Clone for ArgumentSpec

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ArgumentSpec

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ArgumentSpec

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ArgumentSpec

impl PartialEq for ArgumentSpec

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ArgumentSpec

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 ArgumentSpec