Struct Component

pub struct Component {

    pub source: ComponentSource,
    pub description: String,
    pub variables: IndexMap<LowerSnakeId, String>,
    pub environment: IndexMap<String, String>,
    pub files: Vec<WasiFilesMount>,
    pub exclude_files: Vec<String>,
    pub allowed_http_hosts: Vec<String>,
    pub allowed_outbound_hosts: Vec<String>,
    pub key_value_stores: Vec<String>,
    pub sqlite_databases: Vec<String>,
    pub ai_models: Vec<KebabId>,
    pub build: Option<ComponentBuildConfig>,
    pub tool: IndexMap<String, Table>,
    pub dependencies_inherit_configuration: bool,
    pub dependencies: ComponentDependencies,
}

Component definition

Fields

source: ComponentSource

source = ...

description: String

description = "Component description"

variables: IndexMap<LowerSnakeId, String>

variables = { name = "{{ app_var }}"}

environment: IndexMap<String, String>

environment = { VAR = "value" }

files: Vec<WasiFilesMount>

files = [...]

exclude_files: Vec<String>

exclude_files = ["secrets/*"]

allowed_http_hosts: Vec<String>

👎Deprecated

allowed_http_hosts = ["example.com"]

allowed_outbound_hosts: Vec<String>

allowed_outbound_hosts = ["redis://myredishost.com:6379"]

key_value_stores: Vec<String>

key_value_stores = ["default", "my-store"]

sqlite_databases: Vec<String>

sqlite_databases = ["default", "my-database"]

ai_models: Vec<KebabId>

ai_models = ["llama2-chat"]

build: Option<ComponentBuildConfig>

Build configuration

tool: IndexMap<String, Table>

Settings for custom tools or plugins. Spin ignores this field.

dependencies_inherit_configuration: bool

If true, allow dependencies to inherit configuration.

dependencies: ComponentDependencies

Component dependencies

Implementations

impl Component

pub fn normalized_allowed_outbound_hosts(&self) -> Result<Vec<String>>

Combine allowed_outbound_hosts with the deprecated allowed_http_hosts into one array all normalized to the syntax of allowed_outbound_hosts.

Trait Implementations

impl Clone for Component

fn clone(&self) -> Component

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Component

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Component

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for Component

fn schema_name() -> String

The name of the generated JSON Schema.

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

Returns a string that uniquely identifies the schema produced by this type.

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

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

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

impl Serialize for Component

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

where __S: Serializer,

Serialize this value into the given Serde serializer.