Enum FeedbackEffect 

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

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.

RemoveRecording

Leave the recording out of the review.

Toggle

Show a span the review hid, or hide it again.

Fields

index: usize

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.

pub const REMOVE_RECORDING: ActionRef<FeedbackEffect, ()>

Bind a control to the remove-recording effect: Leave the recording out of the review.

pub const TOGGLE: ActionRef<FeedbackEffect, usize>

Bind a control to the toggle effect: Show a span the review hid, or hide it again.

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.

const APP_ID: &'static str = tilo_resource::kind::DEFAULT_APP

The app whose resource offers the vocabulary’s effects, which an effect’s typed reference names its action by: defaults to none of its own, for a vocabulary that is not an app’s (a test’s, a host’s).

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, EffectDecodeError>

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

const LABEL: &'static str = Self::OPERATION

The vocabulary’s name, as its effects are labelled when they are offered on their own.

fn confirmation_phrase(&self) -> Option<String>

What its caller types to confirm this invocation, when its effect declares phrase: the name of what it erases.

fn kind() -> ResourceKind

The kind the vocabulary’s effects are published under, which a typed reference to one names: the operation they travel as, the vocabulary’s name, and the app that offers it.

fn key(&self) -> ActionKey

The key this effect is offered under: the app that offers the vocabulary, the operation its effects travel as, and this effect’s id.

fn spec(id: &str) -> Option<ActionSpec>

The spec id declares: what a control binding it reads, so binding one effect costs one declaration rather than the vocabulary’s.

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 address_on(&self, resource: impl Into<String>) -> ActionAddress

This effect as the published resource resource offers it (the record, or a child or live row it is bound on, by its published id): what a search hit invokes or a caller addresses through the host’s door. Its id comes from the effect itself.

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

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