Struct LockedApp

pub struct LockedApp {
    pub spin_lock_version: FixedVersionBackwardCompatible<1>,
    pub must_understand: Vec<MustUnderstand>,
    pub metadata: Map<String, Value>,
    pub host_requirements: Map<String, Value>,
    pub variables: BTreeMap<String, Variable>,
    pub triggers: Vec<LockedTrigger>,
    pub components: Vec<LockedComponent>,
}

A LockedApp represents a “fully resolved” Spin application.

Fields

spin_lock_version: FixedVersionBackwardCompatible<1>

Locked schema version

must_understand: Vec<MustUnderstand>

Identifies fields in the LockedApp that the host must process if present.

metadata: Map<String, Value>

Application metadata

host_requirements: Map<String, Value>

Host requirements

variables: BTreeMap<String, Variable>

Custom config variables

triggers: Vec<LockedTrigger>

Application triggers

components: Vec<LockedComponent>

Application components

Implementations

impl LockedApp

pub fn from_json(contents: &[u8]) -> Result<LockedApp, Error>

Deserializes a LockedApp from the given JSON data.

pub fn to_json(&self) -> Result<Vec<u8>, Error>

Serializes the LockedApp into JSON data.

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

where T: Deserialize<'this>,

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

where T: Deserialize<'this>,

Deserializes typed metadata for this app.

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

pub fn ensure_needs_only( &self, trigger_type: &str, supported: &[&str], ) -> Result<(), String>

Checks that the application does not have any host requirements outside the supported set. The error case returns a comma-separated list of unmet requirements.

Trait Implementations

impl Clone for LockedApp

fn clone(&self) -> LockedApp

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LockedApp

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for LockedApp

fn deserialize<__D>( __deserializer: __D, ) -> Result<LockedApp, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for LockedApp

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.