Struct spin_app::AppComponent

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

An AppComponent holds configuration for a Spin application component.

Fields

app: &'a App<'a, L>

The app this component belongs to.

Implementations

impl<'a, L> AppComponent<'a, L>

pub fn id(&self) -> &str

Returns this component’s app-unique ID.

pub fn source(&self) -> &LockedComponentSource

Returns this component’s Wasm component or module source.

pub fn files(&self) -> Iter<'_, ContentPath>

Returns an iterator of ContentPaths for this component’s configured “directory mounts”.

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

Deserializes typed metadata for this component.

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 component.

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

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

Returns an iterator of custom config values for this component.

impl<'a> AppComponent<'a>

pub async fn load_component<T: Send + Sync>( &self, engine: &Engine<T> ) -> Result<Component>

Loads and returns the [spin_core::Component] for this component.

pub async fn load_module<T: Send + Sync>( &self, engine: &Engine<T> ) -> Result<Module>

Loads and returns the [spin_core::Module] for this component.

pub async fn apply_store_config(&self, builder: &mut StoreBuilder) -> Result<()>

Updates the given StoreBuilder with configuration for this component.

In particular, the WASI ‘env’ and “preloaded dirs” are set up, and any DynamicHostComponents associated with the source AppLoader are configured.