Enum wick_config::config::WickConfiguration

source ·

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

Expand description

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

Variants§

§

Implementations§

source §

impl WickConfiguration

source

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?;

source

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?;

source

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?;

source

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))?;

source

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))?;

source

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()?;

source

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()?;