Struct spin_app::App

pub struct App<'a, L = AppLoader> { /* private fields */ }

An App holds loaded configuration for a Spin application.

Note: The L param is an implementation detail to support the App::inert constructor.

Implementations

impl<'a, L> App<'a, L>

pub fn get_metadata<'this, T: Deserialize<'this>>( &'this self, key: MetadataKey<T> ) -> Result<Option<T>>

Deserializes typed metadata for this app.

Returns Ok(None) if there is no metadata for the given key and an Err only if there is a value for the key but the typed deserialization failed.

pub fn require_metadata<'this, T: Deserialize<'this>>( &'this self, key: MetadataKey<T> ) -> Result<T>

Deserializes typed metadata for this app.

Like App::get_metadata, but returns an error if there is no metadata for the given key.

pub fn variables(&self) -> impl Iterator<Item = (&String, &Variable)>

Returns an iterator of custom config Variables defined for this app.

pub fn components(&self) -> impl Iterator<Item = AppComponent<'_, L>>

Returns an iterator of AppComponents defined for this app.

pub fn get_component(&self, component_id: &str) -> Option<AppComponent<'_, L>>

Returns the AppComponent with the given component_id, or None if it doesn’t exist.

pub fn triggers(&self) -> impl Iterator<Item = AppTrigger<'_, L>>

Returns an iterator of AppTriggers defined for this app.

pub fn get_trigger_metadata<'this, T: Deserialize<'this> + Default>( &'this self, trigger_type: &'a str ) -> Result<Option<T>>

Returns the trigger metadata for a specific trigger type.

pub fn triggers_with_type( &'a self, trigger_type: &'a str ) -> impl Iterator<Item = AppTrigger<'_, L>>

Returns an iterator of AppTriggers defined for this app with the given trigger_type.

impl<'a> App<'a>

pub fn uri(&self) -> &str

Returns a Loader-implementation-specific URI for this app.

impl App<'static, InertLoader>

pub fn inert(locked: LockedApp) -> Self

Return an “inert” App which does not have an associated AppLoader and cannot be used to instantiate components.

Trait Implementations

impl<'a, L: Debug> Debug for App<'a, L>

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

Formats the value using the given formatter.