ComponentDependency

Enum ComponentDependency 

Source
pub enum ComponentDependency {
    Version(String),
    Package {
        version: String,
        registry: Option<String>,
        package: Option<String>,
        export: Option<String>,
    },
    Local {
        path: PathBuf,
        export: Option<String>,
    },
    HTTP {
        url: String,
        digest: String,
        export: Option<String>,
    },
}
Expand description

Specifies how to satisfy an import dependency of the component. This may be one of:

  • A semantic versioning constraint for the package version to use. Spin fetches the latest matching version of the package whose name matches the dependency name from the default registry.

Example: "my:dep/import" = ">= 0.1.0"

  • A package from a registry.

Example: "my:dep/import" = { version = "0.1.0", registry = "registry.io", ...}

  • A package from a filesystem path.

Example: "my:dependency" = { path = "path/to/component.wasm", export = "my-export" }

  • A package from an HTTP URL.

Example: "my:import" = { url = "https://example.com/component.wasm", sha256 = "sha256:..." }

Learn more: https://spinframework.dev/v3/writing-apps#using-component-dependencies

Variants§

§

Version(String)

... = ">= 0.1.0"

§

Package

... = { version = "0.1.0", registry = "registry.io", ...}

Fields

§version: String

A semantic versioning constraint for the package version to use. Required. Spin fetches the latest matching version from the specified registry, or from the default registry if no registry is specified.

Example: "my:dep/import" = { version = ">= 0.1.0" }

Learn more: https://spinframework.dev/writing-apps#dependencies-from-a-registry

§registry: Option<String>

The registry that hosts the package. If omitted, this defaults to your system default registry.

Example: "my:dep/import" = { registry = "registry.io", version = " 0.1.0" }

Learn more: https://spinframework.dev/writing-apps#dependencies-from-a-registry

§package: Option<String>

The name of the package to use. If omitted, this defaults to the package name of the imported interface.

Example: "my:dep/import" = { package = "your:implementation", version = " 0.1.0" }

Learn more: https://spinframework.dev/writing-apps#dependencies-from-a-registry

§export: Option<String>

The name of the export in the package. If omitted, this defaults to the name of the import.

Example: "my:dep/import" = { export = "your:impl/export", version = " 0.1.0" }

Learn more: https://spinframework.dev/writing-apps#dependencies-from-a-registry

§

Local

... = { path = "path/to/component.wasm", export = "my-export" }

Fields

§path: PathBuf

The path to the Wasm file that implements the dependency.

Example: "my:dep/import" = { path = "path/to/component.wasm" }

Learn more: https://spinframework.dev/writing-apps#dependencies-from-a-local-component

§export: Option<String>

The name of the export in the package. If omitted, this defaults to the name of the import.

Example: "my:dep/import" = { export = "your:impl/export", path = "path/to/component.wasm" }

Learn more: https://spinframework.dev/writing-apps#dependencies-from-a-local-component

§

HTTP

... = { url = "https://example.com/component.wasm", sha256 = "..." }

Fields

§url: String

The URL to the Wasm component that implements the dependency.

Example: "my:dep/import" = { url = "https://example.com/component.wasm", sha256 = "sha256:..." }

Learn more: https://spinframework.dev/writing-apps#dependencies-from-a-url

§digest: String

The SHA256 digest of the Wasm file. This is required for integrity checking. Must begin with sha256:.

Example: "my:dep/import" = { sha256 = "sha256:...", ... }

Learn more: https://spinframework.dev/writing-apps#dependencies-from-a-url

§export: Option<String>

The name of the export in the package. If omitted, this defaults to the name of the import.

Example: "my:dep/import" = { export = "your:impl/export", ... }

Learn more: https://spinframework.dev/writing-apps#dependencies-from-a-url

Trait Implementations§

Source§

impl Clone for ComponentDependency

Source§

fn clone(&self) -> ComponentDependency

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ComponentDependency

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for ComponentDependency

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl JsonSchema for ComponentDependency

Source§

fn schema_name() -> String

The name of the generated JSON Schema. Read more
Source§

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type. Read more
Source§

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword. Read more
Source§

impl Serialize for ComponentDependency

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> MaybeSendSync for T