Struct Gather

pub struct Gather {
    pub type: Type,
    pub output: Box<JsonSchema>,
    pub confirm_content: Option<bool>,
    pub hooks: Option<Vec<Hook>>,
    pub max_retries: Option<f64>,
    pub literal_template: Option<String>,
    pub name: String,
    pub metadata: Option<Value>,
}

Fields

type: Type

output: Box<JsonSchema>

confirm_content: Option<bool>

This is whether or not the workflow should read back the gathered data to the user, and ask about its correctness.

hooks: Option<Vec<Hook>>

This is a list of hooks for a task. Each hook is a list of tasks to run on a trigger (such as on start, on failure, etc). Only Say is supported for now.

max_retries: Option<f64>

This is the number of times we should try to gather the information from the user before we failover to the fail path. An example of this would be a user refusing to give their phone number for privacy reasons, and then going down a different path on account of this

literal_template: Option<String>

This is a liquid templating string. On the first call to Gather, the template will be filled out with variables from the context, and will be spoken verbatim to the user. An example would be "Base on your zipcode, it looks like you could be in one of these counties: {{ counties | join: ", " }}. Which one do you live in?"

name: String

metadata: Option<Value>

This is for metadata you want to store on the task.

Implementations

impl Gather

pub fn new(type: Type, output: JsonSchema, name: String) -> Gather

Trait Implementations

impl Clone for Gather

fn clone(&self) -> Gather

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Gather

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

Formats the value using the given formatter.

impl Default for Gather

fn default() -> Gather

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Gather

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Gather

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

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 Gather