Trait Trigger

pub trait Trigger<F: RuntimeFactors>: Sized + Send {
    type CliArgs: Args;
    type InstanceState: Send + 'static;

    const TYPE: &'static str;

    // Required methods
    fn new(cli_args: Self::CliArgs, app: &App) -> Result<Self>;
    fn run(
        self,
        trigger_app: TriggerApp<Self, F>,
    ) -> impl Future<Output = Result<()>> + Send;

    // Provided methods
    fn add_to_linker(
        &mut self,
        linker: &mut Linker<InstanceState<<F as RuntimeFactors>::InstanceState, <Self as Trigger<F>>::InstanceState>>,
    ) -> Result<()> { ... }
    fn supported_host_requirements() -> Vec<&'static str> { ... }
}

A trigger for a Spin runtime.

Required Associated Constants

const TYPE: &'static str

A unique identifier for this trigger.

Required Associated Types

type CliArgs: Args

The specific CLI arguments for this trigger.

type InstanceState: Send + 'static

The instance state for this trigger.

Required Methods

fn new(cli_args: Self::CliArgs, app: &App) -> Result<Self>

Constructs a new trigger.

fn run( self, trigger_app: TriggerApp<Self, F>, ) -> impl Future<Output = Result<()>> + Send

Run this trigger.

Provided Methods

fn add_to_linker( &mut self, linker: &mut Linker<InstanceState<<F as RuntimeFactors>::InstanceState, <Self as Trigger<F>>::InstanceState>>, ) -> Result<()>

Update the Linker for this trigger.

fn supported_host_requirements() -> Vec<&'static str>

Returns a list of host requirements supported by this trigger specifically.

See App::ensure_needs_only.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl<F: RuntimeFactors> Trigger<F> for HelpArgsOnlyTrigger

const TYPE: &'static str = "help-args-only"

type CliArgs = NoCliArgs

type InstanceState = ()