Struct ActionInvocation 

pub struct ActionInvocation { /* private fields */ }

A request for the application to run an action.

Invocation is the handoff point between a UI surface and application-owned dispatch. The action crate does not execute callbacks or mutate application state.

Use new for actions without arguments and with_args when a UI surface has collected inputs. Dispatch code usually reads id, args, and source.

Examples

use ratatui_action::id::InputId;
use ratatui_action::invocation::{ActionArgs, ActionInvocation, InvocationSource};

let mut args = ActionArgs::new();
args.insert(InputId::new("theme"), "github-dark");

let invocation = ActionInvocation::with_args("theme.switch", args, InvocationSource::Palette);

assert_eq!(invocation.id().as_str(), "theme.switch");
assert_eq!(invocation.source(), InvocationSource::Palette);

Implementations

impl ActionInvocation

pub fn new(id: impl Into<ActionId>, source: InvocationSource) -> Self

Creates an invocation with no arguments.

pub fn with_args( id: impl Into<ActionId>, args: ActionArgs, source: InvocationSource, ) -> Self

Creates an invocation with resolved arguments.

pub fn id(&self) -> &ActionId

Returns the action identifier to invoke.

pub fn args(&self) -> &ActionArgs

Returns resolved invocation arguments.

pub fn source(&self) -> InvocationSource

Returns the surface that requested this invocation.

Trait Implementations

impl Clone for ActionInvocation

fn clone(&self) -> ActionInvocation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ActionInvocation

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

Formats the value using the given formatter.

impl Eq for ActionInvocation

impl PartialEq for ActionInvocation

fn eq(&self, other: &ActionInvocation) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ActionInvocation