Enum WickConfiguration 

pub enum WickConfiguration {
    Component(ComponentConfiguration),
    App(AppConfiguration),
    Types(TypesConfiguration),
    Tests(TestConfiguration),
    Lockdown(LockdownConfiguration),
}

A catch-all enum for root-level Wick configurations.

Variants

Component(ComponentConfiguration)

A component_config::ComponentConfiguration configuration.

App(AppConfiguration)

An app_config::AppConfiguration configuration.

Types(TypesConfiguration)

A types_config::TypesConfiguration configuration.

Tests(TestConfiguration)

A test_config::TestConfiguration configuration.

Lockdown(LockdownConfiguration)

A lockdown_config::LockdownConfiguration configuration.

Implementations

impl WickConfiguration

pub async fn fetch_tree( path: impl Into<AssetReference> + Send, root_config: Option<RuntimeConfig>, root_env: Option<HashMap<String, String>>, options: FetchOptions, ) -> Result<ConfigurationTreeNode<WickConfiguration>, Error>

Fetch a configuration and all referenced assets from a path.

Example

use wick_config::WickConfiguration;
use wick_asset_reference::FetchOptions;

let opts = FetchOptions::default();
let env : HashMap<String,String> = std::env::vars().collect();
let root_config = None;

let manifest = WickConfiguration::fetch_tree("path/to/manifest.yaml", root_config, env, opts).await?;

pub async fn fetch_uninitialized_tree( path: impl Into<AssetReference> + Send, options: FetchOptions, ) -> Result<ConfigurationTreeNode<UninitializedConfiguration>, Error>

Fetch a configuration and all referenced assets from a path.

Example

use wick_config::WickConfiguration;
use wick_asset_reference::FetchOptions;

let opts = FetchOptions::default();

let manifest = WickConfiguration::fetch_uninitialized_tree("path/to/manifest.yaml", opts).await?;

pub async fn fetch( asset: impl Into<AssetReference> + Send, options: FetchOptions, ) -> Result<UninitializedConfiguration, Error>

Fetch a configuration from a path.

Example

use wick_config::WickConfiguration;
use wick_asset_reference::FetchOptions;

let opts = FetchOptions::default();

let manifest = WickConfiguration::fetch("path/to/manifest.yaml", opts).await?;

pub fn load_from_bytes( bytes: &[u8], source: &Option<PathBuf>, ) -> Result<UninitializedConfiguration, Error>

Load a configuration from raw bytes. Pass in an optional source to track where the bytes came from.

Example

use wick_config::WickConfiguration;
use std::path::PathBuf;

let path = PathBuf::from("path/to/manifest.yaml");

let bytes = std::fs::read(&path)?;

let manifest = WickConfiguration::load_from_bytes(&bytes, &Some(path))?;

pub fn from_yaml( src: &str, source: &Option<PathBuf>, ) -> Result<UninitializedConfiguration, Error>

Load a configuration from a string. Pass in an optional source to track where the string came from.

Example

use std::path::PathBuf;
use wick_config::WickConfiguration;

let path = PathBuf::from("path/to/manifest.yaml");

let string = std::fs::read_to_string(&path)?;

let manifest = WickConfiguration::from_yaml(&string, &Some(path))?;

pub fn into_v1_yaml(self) -> Result<String, Error>

Convert a WickConfiguration into V1 configuration yaml source.

Example

use wick_config::WickConfiguration;
use wick_asset_reference::FetchOptions;

let opts = FetchOptions::default();

let manifest = WickConfiguration::fetch_all("path/to/manifest.yaml", opts).await?;
let manifest = manifest.finish()?;

let v1_yaml = manifest.into_v1_yaml()?;

pub fn into_v1_json(self) -> Result<Value, Error>

Convert a WickConfiguration into a V1 configuration JSON value.

Example

use wick_config::WickConfiguration;
use wick_asset_reference::FetchOptions;

let opts = FetchOptions::default();

let manifest = WickConfiguration::fetch_all("path/to/manifest.yaml", opts).await?;
let manifest = manifest.finish()?;

let v1_json = manifest.into_v1_json()?;

pub fn name(&self) -> Option<&str>

Get the name (if any) associated with the inner configuration.

pub fn metadata(&self) -> Option<&Metadata>

Get the metadata (if any) associated with the inner configuration.

pub fn validate(&self) -> Result<(), Error>

Validate this configuration is good.

pub const fn kind(&self) -> ConfigurationKind

Get the kind of the inner configuration.

pub fn resources(&self) -> &[Binding<ResourceDefinition>]

Get the resources for the configuration, if any

pub fn version(&self) -> Option<&str>

Get the version (if any) associated with the inner configuration.

pub fn package(&self) -> Option<&PackageConfig>

Get the package configuration (if any) associated with the inner configuration.

pub fn try_component_config(self) -> Result<ComponentConfiguration, Error>

Unwrap the inner ComponentConfiguration, returning an error if it is anything else.

pub fn try_app_config(self) -> Result<AppConfiguration, Error>

Unwrap the inner AppConfiguration, returning an error if it is anything else.

pub fn try_test_config(self) -> Result<TestConfiguration, Error>

Unwrap the inner TestConfiguration, returning an error if it is anything else.

pub fn try_types_config(self) -> Result<TypesConfiguration, Error>

Unwrap the inner TypesConfiguration, returning an error if it is anything else.

pub fn try_lockdown_config(self) -> Result<LockdownConfiguration, Error>

Unwrap the inner LockdownConfiguration, returning an error if it is anything else.

pub fn set_source(&mut self, src: &Path)

Set the source of the configuration if it is not already set on load.

pub fn source(&self) -> Option<&Path>

Get the source of the configuration.

Trait Implementations

impl AssetManager for WickConfiguration

type Asset = AssetReference

fn set_baseurl(&self, baseurl: &Path)

fn assets(&self) -> Assets<'_, AssetReference>

fn get_asset_flags(&self) -> u32

impl Clone for WickConfiguration

fn clone(&self) -> WickConfiguration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WickConfiguration

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

Formats the value using the given formatter.

impl Imports for WickConfiguration

fn imports(&self) -> &[Binding<ImportDefinition>]

Return a list of the imported configuration bindings.

impl Lockdown for WickConfiguration

fn lockdown( &self, id: Option<&str>, lockdown: &LockdownConfiguration, ) -> Result<(), LockdownError>

Apply a lockdown configuration to the current configuration.

impl RootConfig for WickConfiguration

fn root_config(&self) -> Option<&RuntimeConfig>

Return the rendered wick_packet::RuntimeConfig.

fn set_root_config(&mut self, config: Option<RuntimeConfig>)

Set a rendered wick_packet::RuntimeConfig.

impl Serialize for WickConfiguration

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<WickConfig> for WickConfiguration

type Error = ManifestError

The type returned in the event of a conversion error.

fn try_from(def: WickConfig) -> Result<Self, Error>

Performs the conversion.