Struct OperationSpec 

#[non_exhaustive]
pub struct OperationSpec {
    pub key: OperationKey,
    pub workflow: WorkflowKey,
    pub summary: String,
    pub summaries: BTreeMap<Locale, String>,
    pub guidance: Option<String>,
    pub target_policy: TargetPolicy,
    pub mutability: ActMutability,
    pub availability: ActAvailability,
    pub arguments_schema: Schema,
    pub arguments: Vec<ArgumentSpec>,
    pub examples: Vec<OperationExample>,
    pub context_reads: Vec<ReadToolKey>,
    /* private fields */
}

One operation a workflow offers in a view.

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.

key: OperationKey

Its key, unique across the registry.

workflow: WorkflowKey

The workflow offering it; the registry fills it in.

summary: String

One line saying what it does, for choosing among operations.

summaries: BTreeMap<Locale, String>

The summary in other languages, by locale; the one above serves every other.

guidance: Option<String>

Longer guidance for filling its arguments.

target_policy: TargetPolicy

Which records it may aim at.

mutability: ActMutability

Whether it changes a record.

availability: ActAvailability

Whether a model may propose it, or only a card.

arguments_schema: Schema

The JSON Schema of its arguments type.

arguments: Vec<ArgumentSpec>

Its arguments, in the schema’s order.

examples: Vec<OperationExample>

Examples of messages and what they give.

context_reads: Vec<ReadToolKey>

Reads whose results the argument filler is to be shown; declared, not yet run.

Implementations

impl OperationSpec

pub fn new(key: impl Into<OperationKey>) -> Self

An operation named key that takes no arguments and changes an existing record.

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

Says in one line what it does.

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

Says what it does in locale’s language, for a turn in that language.

pub fn summary_for(&self, locale: &Locale) -> &str

Its summary for a turn in locale: that locale’s, then its language’s, then the summary every other language reads.

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

Adds guidance for filling its arguments.

pub const fn target(self, policy: TargetPolicy) -> Self

Sets which records it may aim at.

pub const fn read_only(self) -> Self

Marks it as changing nothing.

pub const fn mutating(self) -> Self

Marks it as changing a record, which is the default.

pub const fn card_only(self) -> Self

Lets only a card run it.

pub fn arguments<A: JsonSchema + DeserializeOwned + 'static>(self) -> Self

Takes its arguments from A, deriving one ArgumentSpec per top-level field.

pub fn argument( self, name: &str, adjust: impl FnOnce(ArgumentSpec) -> ArgumentSpec, ) -> Self

Adjusts the argument named name.

pub fn example(self, message: impl Into<String>, arguments: Value) -> Self

Adds an example message and the arguments it gives.

pub fn example_not_given<'a>( self, message: impl Into<String>, names: impl IntoIterator<Item = &'a str>, ) -> Self

Adds an example message that names or implies names without giving them.

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

Names a read whose result the argument filler is to be shown. Declared only: no stage runs reads in 0.1 (docs/roadmap.md).

pub fn arguments_value( &self, values: impl IntoIterator<Item = (String, Value)>, ) -> Value

The arguments document an act passes: null for an operation declared with no arguments type, an object otherwise.

pub fn check_arguments(&self, arguments: &Value) -> Result<(), String>

Checks an act’s arguments against the arguments type.

Errors

Why they do not fit, as a path and not as the value.

pub fn argument_named(&self, name: &str) -> Option<&ArgumentSpec>

The argument named name.

pub fn validate(&self) -> Result<(), OperationSpecError>

Checks the declaration: every adjusted argument exists, and every example gives arguments of the right type and names only real ones.

Errors

The first problem found, naming the operation.

Trait Implementations

impl Clone for OperationSpec

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 OperationSpec

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OperationSpec

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for OperationSpec

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for OperationSpec

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

where __S: Serializer,

Serialize this value into the given Serde serializer.