Enum FeedbackEffect 

pub enum FeedbackEffect {
    Review,
    Submit,
    Retry,
    Redact {
        key: String,
        start: usize,
        end: usize,
    },
    RemoveScreenshot,
}

Variants

Review

Inspect exactly what will leave this device.

Submit

Approve the displayed review and durably queue it.

Retry

Retry the immutable report and read its durable delivery status.

Redact

Hide a span in the already-masked review.

Fields

key: String

start: usize

end: usize

RemoveScreenshot

Remove the screenshot from the review.

Implementations

impl FeedbackEffect

pub const REVIEW: ActionRef<FeedbackEffect, ()>

Bind a control to the review effect: Inspect exactly what will leave this device.

pub const SUBMIT: ActionRef<FeedbackEffect, ()>

Bind a control to the submit effect: Approve the displayed review and durably queue it.

pub const RETRY: ActionRef<FeedbackEffect, ()>

Bind a control to the retry effect: Retry the immutable report and read its durable delivery status.

pub const REDACT: ActionRef<FeedbackEffect, (String, usize, usize)>

Bind a control to the redact effect: Hide a span in the already-masked review.

pub const REMOVE_SCREENSHOT: ActionRef<FeedbackEffect, ()>

Bind a control to the remove-screenshot effect: Remove the screenshot from the review.

Trait Implementations

impl Clone for FeedbackEffect

fn clone(&self) -> FeedbackEffect

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FeedbackEffect

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

Formats the value using the given formatter.

impl Effect for FeedbackEffect

const OPERATION: &'static str = "feedback.compose"

The operation type every effect of the vocabulary travels under: unique per vocabulary, like a resource’s kind.

fn declarations() -> Vec<EffectDecl>

One declaration per effect, in order.

fn declaration(id: &str) -> Option<EffectDecl>

The declaration of the effect id, built alone: what binding one effect to an item reads, so offering it on many items costs one declaration each, not the whole vocabulary.

fn id(&self) -> &'static str

This effect’s id among the declarations.

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

This effect’s arguments, named as its declaration’s parameters.

fn decode(id: &str, arguments: &Map<String, Value>) -> Result<Self, String>

The effect id with arguments, as a caller invoked it.

fn specs() -> Vec<ActionSpec>

The published action of every effect offered on the resource: all but the row ones, which are offered only bound.

fn bound(&self) -> ActionSpec

This effect with its arguments as one action that takes none: what a published child or a live row offers (open this snippet, stop this process), answered by the vocabulary’s handler like any other invocation of the effect, under the same contract as its declaration.

fn bound_asking(&self, asking: &[&str]) -> ActionSpec

This effect bound to the item it acts on, as bound, still asking its caller for the arguments named in asking: rename this file, to a name the caller gives. The bound arguments are this effect’s own; an asked one the caller supplies replaces it.

fn bound_asking_params(&self, params: Vec<ActionParam>) -> ActionSpec

bound_asking with the asked parameters given whole, narrowed for this item: the applications that can open this file as the choices of app.

fn item_specs(field: &str, item: &Id) -> Vec<ActionSpec>

The effects offered on the item item of the collection field (#[effect(item = field)]), each with its first parameter bound to the item and the rest still asked.

fn from_payload(payload: &[u8]) -> Result<Self, String>

Decode one invocation’s payload, as the operation’s specs encode it.