Struct Action 

pub struct Action {
    pub group: String,
    pub label: String,
    pub why: String,
    pub command: String,
    pub run: Option<Runnable>,
    pub step: Option<How>,
    pub blocked: Option<String>,
    pub input: Option<String>,
    pub confirm: Option<String>,
    pub id: ActionId,
    pub role: Option<SkillRole>,
}

One thing a person can do now.

Fields

group: String

next, plan, work, task, feature or review.

label: String

What it does, in a few words.

why: String

Why, or what follows (shown beside it).

command: String

The equivalent command; "…" marks the input.

run: Option<Runnable>

How an interface runs it; None: see step.

step: Option<How>

How an interface takes it when it does not run it (run is None): a view it opens, the person’s own command, a line for their shell.

blocked: Option<String>

Why it cannot run now; None: it can.

input: Option<String>

What to ask for before it runs (Describe the feature).

confirm: Option<String>

It leaves the machine (a push, a pull request) or cannot be undone (a discard): what an interface says in a confirmation before it runs it.

id: ActionId

What it is, independent of its wording (identity).

role: Option<SkillRole>

A planning skill’s part in its format’s planning; None for everything else.

Implementations

impl Action

pub fn new( group: &str, label: impl Into<String>, why: impl Into<String>, command: impl Into<String>, ) -> Self

An action that stands for command, which the person runs.

pub fn with_run(self, run: Runnable) -> Self

Run by an interface as run; its identity follows.

pub const fn with_role(self, role: SkillRole) -> Self

A planning skill playing role.

pub const fn runnable(&self) -> bool

It can be run from an interface, now.

Trait Implementations

impl Clone for Action

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 Action

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

Formats the value using the given formatter.

impl Eq for Action

impl JsonSchema for Action

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for Action

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Action

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 Action