Struct ActionDecl 

pub struct ActionDecl<R>
where
    R: Resource,
{ /* private fields */ }

One mutation offered by name: a [Declaration] of the resource R, whose fields it derefs to.

Implementations

impl<R> ActionDecl<R>

where R: Resource,

pub fn edit_asking<V>( id: &'static str, label: impl Into<String>, param: &'static str, description: &'static str, make: impl Fn(V) -> Edit<R> + Send + Sync + 'static, ) -> ActionDecl<R>

where V: DeserializeOwned + JsonSchema,

A field edit whose one value its caller supplies, offered as the action id labelled label: the parameter param (described by description, typed by V’s schema) becomes the edit make(value). What a row offers when the edit is bound to it but its value is not (“Rename playlist”, “Add a song to this playlist”).

pub fn edit( id: &'static str, label: impl Into<String>, edit: Edit<R>, ) -> ActionDecl<R>

where Edit<R>: Send + Sync,

The field edit edit offered as the action id labelled label, its value bound: what a place or a live row offers (“Use Proton for Adobe Reader”), checked and recorded as the edit itself.

pub fn new( id: &'static str, label: impl Into<String>, params: Vec<ActionParam>, build: impl Fn(&ActionArgs, i64) -> Result<<R as Resource>::Action, String> + Send + Sync + 'static, ) -> ActionDecl<R>

pub fn into_declaration(self) -> Declaration

The declaration, of whichever resource.

pub fn build_action( &self, args: &ActionArgs, now_ms: i64, ) -> Result<<R as Resource>::Action, String>

The action it builds from args at now_ms.

Errors

Why the arguments do not make the action.

pub fn refining(self) -> ActionDecl<R>

Mark a bound edit as refining the resource’s declared action of the same id (bind_declaration).

pub fn tagged(self, tag: impl Into<String>) -> ActionDecl<R>

Tag the action’s contract (ContextRequirement::Caret.tag(), an incremental-text declaration) for the callers that read it.

pub fn describe(self, description: impl Into<String>) -> ActionDecl<R>

pub fn returns(self, result: ResultSpec) -> ActionDecl<R>

Declare what the action answers its caller with (an outline of the state it left), which the hosting surface supplies after it applies.

pub fn of_kind(self, kind: ActionKind) -> ActionDecl<R>

Set what the action is able to do.

pub fn below_field(self, field: &'static str) -> ActionDecl<R>

Place the action below the one field it writes.

pub fn destructive(self) -> ActionDecl<R>

pub fn writing(self, units: Vec<String>) -> ActionDecl<R>

The units the action writes, as the surface lists them ([crate::footprint]).

pub fn answering(self) -> ActionDecl<R>

Answer the caller with what the action made, from Resource::answer.

Trait Implementations

impl<R> AsRef<Declaration> for ActionDecl<R>

where R: Resource,

fn as_ref(&self) -> &Declaration

Converts this type into a shared reference of the (usually inferred) input type.

impl<R> Clone for ActionDecl<R>

where R: Resource,

fn clone(&self) -> ActionDecl<R>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<R> Deref for ActionDecl<R>

where R: Resource,

type Target = Declaration

The resulting type after dereferencing.

fn deref(&self) -> &Declaration

Dereferences the value.

impl<R> DerefMut for ActionDecl<R>

where R: Resource,

fn deref_mut(&mut self) -> &mut Declaration

Mutably dereferences the value.