Struct AppComponent

pub struct AppComponent<'a> {
    pub app: &'a App,
    pub locked: &'a LockedComponent,
}

An AppComponent holds configuration for a Spin application component.

Fields

app: &'a App

The app this component belongs to.

locked: &'a LockedComponent

The locked component.

Implementations

impl<'a> AppComponent<'a>

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 environment(&self) -> impl IntoIterator<Item = (&str, &str)>

Returns an iterator of environment variable (key, value) pairs.

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

Returns an iterator of [ContentPath]s for this component’s configured “directory mounts”.

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

where T: Deserialize<'a>,

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>( &'this self, key: MetadataKey<T>, ) -> Result<T, Error>

where T: Deserialize<'this>,

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.