Enum TextAssistancePrefsAction 

pub enum TextAssistancePrefsAction {
    FieldEdit(Edit<TextAssistancePrefs>),
}

The replayable actions of TextAssistancePrefs, one per #[action] method.

Variants

FieldEdit(Edit<TextAssistancePrefs>)

A field edit: a path into the record and an operation.

Trait Implementations

impl Clone for TextAssistancePrefsAction

fn clone(&self) -> TextAssistancePrefsAction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TextAssistancePrefsAction

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TextAssistancePrefsAction

fn deserialize<D>( deserializer: D, ) -> Result<TextAssistancePrefsAction, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Operation for TextAssistancePrefsAction

const KIND: &'static str = "settings.text-assistance"

The resource kind the record is published as.

type Record = TextAssistancePrefs

fn edit(&self) -> Option<&Edit<TextAssistancePrefs>>

The field edit this operation is, when it is one: it applies at its path instead of through [Self::perform].

fn kind(&self) -> ActionKind

What this operation can do. #[resource] derives it from each verb’s signature.

fn field_edit( edit: Edit<TextAssistancePrefs>, ) -> Option<TextAssistancePrefsAction>

The field edit edit as an operation of the record.

fn perform( &self, _record: &mut TextAssistancePrefs, _cx: &mut ActionCx, ) -> Result<(), Refusal>

Run the operation’s method on the record.

fn snapshot(record: &TextAssistancePrefs) -> Option<TextAssistancePrefs>

A copy of record, so the next action can start from it rather than read the whole record from the document again. #[resource] generates it for a Clone record; without one (the default) every action reads the record whole.

fn risk(&self) -> RiskLevel

The consequence class of this operation. #[resource] generates it from #[action(destructive)], so the same method reached through the generic apply action is confirmed exactly as its named declaration is.

fn writes(&self) -> Writes

The units this operation may write beside the record unit (see [crate::footprint]). #[resource] generates it: an item verb its item, #[action(writes = field)] the fields named.

fn change_kind(&self) -> ChangeKind

What the operation is to the people sharing the record: content, housekeeping about it, or content from outside that is nobody’s undo step. #[resource] generates it from #[action(housekeeping)] and #[action(external)].

fn incoming_message(&self) -> bool

Whether the operation records a message someone received. #[resource] generates it from #[action(incoming_message)].

fn compensates(&self) -> bool

Whether this operation declares the verb that undoes it (#[action(undo = path)]).

const QUEUES: bool = false

Whether every change of the record may queue an outside consequence (#[resource(queue = path)]): [Self::queue] runs after each.

fn queue(record: &mut Self::Record, before: &Self::Record, cx: &mut ActionCx)

Queue in the record’s outboxes what the change from before to record must do outside (#[resource(queue = path)]).

fn perform_item( &self, doc: &mut AutoCommit, cx: &mut ActionCx, ) -> Option<Result<(), Refusal>>

Apply an item method (fn star(contact: &mut Contact)) to its item alone in doc: read the item, run the method, write what changed. None for any other operation, or where the record holds an invariant of its own.

fn compensation( &self, before: &Self::Record, after: &Self::Record, minted: &[Id], ) -> Option<Result<Self, String>>

The verb that undoes this one, from the record before and after it ran and the ids it minted (#[action(undo = path)]). None when it declares none: undo then reverts the document by inverse patches.

impl Serialize for TextAssistancePrefsAction

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.