Struct Draft 

pub struct Draft {
    pub action_label: String,
    pub resource_label: String,
    pub description: Option<String>,
    pub layout: DraftLayout,
    pub fields: Vec<DraftField>,
    pub undoable: bool,
}

An invocation as a person reviews it.

Fields

action_label: String

resource_label: String

description: Option<String>

layout: DraftLayout

fields: Vec<DraftField>

undoable: bool

Whether the action, once taken, can be undone (ActionContract::can_be_undone): a reviewer is told whether it sends something away or changes their own work.

Implementations

impl Draft

pub fn render( descriptor: &ActionDescriptor, arguments: &Map<String, Value>, ) -> Draft

pub fn role(&self, role: MessageRole) -> Option<&DraftField>

pub fn gist(&self) -> Option<String>

What the draft is about, in one line of its own values: a message’s recipients and subject, otherwise its first short values. None for a draft with nothing to show.

pub fn apply_edits( &self, arguments: &Map<String, Value>, edits: &[DraftEdit], ) -> Result<Map<String, Value>, String>

arguments with the person’s edits applied. Only fields this draft offers for editing change, each keeping its JSON type.

pub fn check_edits(&self, edits: &[DraftEdit]) -> Result<(), String>

Whether every one of edits changes a field this draft offers for editing to a value of its type.

pub fn arguments(&self) -> Option<Map<String, Value>>

The arguments this draft shows: each text, number and flag field set at its path. None when a field shows its value only in part (a secret, a list, a resource, a text cut short). A draft also leaves out nulls and empty texts, so what this returns is only a candidate: act on it only when it digests (arguments_digest) to the digest the draft was confirmed for.

pub fn edited(&self, edits: &[DraftEdit]) -> Draft

The draft as edits change it: what the person confirmed, shown back to them. Edits this draft does not offer are left out.

Trait Implementations

impl Clone for Draft

fn clone(&self) -> Draft

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Draft

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

Formats the value using the given formatter.

impl Default for Draft

fn default() -> Draft

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Draft

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Draft

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

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 Draft

impl StructuralPartialEq for Draft