Trait HeaderAction 

pub trait HeaderAction: 'static {
    type Input: ActionInput;

    const NAME: &'static str;
    const CONFIRM: bool = false;

    // Required method
    fn run(
        cx: &Cx,
        input: Self::Input,
        ex: &mut dyn Executor,
    ) -> impl Future<Output = Result<()>> + Send;

    // Provided methods
    fn label(_cx: &Cx) -> String { ... }
    fn can_run(_cx: &Cx) -> bool { ... }
    fn validate_input(_cx: &Cx, _input: &Self::Input) -> FieldErrors { ... }
    fn success(cx: &Cx) -> String { ... }
}

A mutation that acts on no record, run from a button in a page’s header: “import posts”, “clear the cache”, “recompute the totals”.

A resource declares one with ResourceDef::header_action, and its list page renders the button; a Page declares one in Page::header_actions, and renders the buttons with header_action_buttons:

struct RecountTags;

impl HeaderAction for RecountTags {
    type Input = ();
    const NAME: &'static str = "recount-tags";

    async fn run(_cx: &Cx, _: (), _ex: &mut dyn Executor) -> Result<()> {
        // Recount through `ex`, the framework's transaction.
        Ok(())
    }
}

The framework owns everything around run, as it does for a record’s Action:

• the route, {url}/-/actions/{NAME} under the list or page URL, and its CSRF check;
• who may run it: on a resource, the policy’s Ability::ViewAny and Ability::RunHeader with the action’s NAME; on a page, Page::can_access; on either, then can_run. A refusal answers 403 and renders no button;
• the transaction: run writes through its executor, and an error rolls everything back;
• on a resource, Resource::after_commit with Mutation::Action and no records once the transaction commits;
• the success notification, and the redirect back to the list or page.

An action that asks for an Input renders it as a form page first, as a record’s action does, and runs on its submit.

Required Associated Constants

const NAME: &'static str

The action’s URL segment, distinct among the actions of its resource or page.

A name that is not a single path segment does not compile, as for Action::NAME.

Provided Associated Constants

const CONFIRM: bool = false

Whether the action asks first through a confirmation dialog with destructive wording. Defaults to false.

An action with input confirms in its input dialog, or on its input page, instead. An unconfirmed POST that would write answers 400.

Required Associated Types

type Input: ActionInput

What the action asks for before it runs: () for nothing, or an ActionInput struct.

Required Methods

fn run( cx: &Cx, input: Self::Input, ex: &mut dyn Executor, ) -> impl Future<Output = Result<()>> + Send

Perform the action with the parsed input, through the framework’s transaction ex.

Provided Methods

fn label(_cx: &Cx) -> String

The button text. Defaults to NAME in sentence case: "recount-tags" reads “Recount tags”.

fn can_run(_cx: &Cx) -> bool

Whether the request may run the action, beyond the policy or the page’s access: a feature flag, a role the policy does not model. Defaults to true.

fn validate_input(_cx: &Cx, _input: &Self::Input) -> FieldErrors

Refuse an input run should not receive. Each error names an input field’s key and renders under its control. Defaults to none.

fn success(cx: &Cx) -> String

The success notification after a commit. Defaults to the label: "Recount tags: done".

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors