Struct wf2_core::context::Context

pub struct Context {
    pub recipe: RecipeKinds,
    pub cwd: PathBuf,
    pub run_mode: RunMode,
    pub name: String,
    pub domains: Vec<String>,
    pub term: Term,
    pub pv: Option<String>,
    pub npm_path: PathBuf,
    pub php_version: PHP,
    pub config_path: Option<PathBuf>,
    pub env: Option<Value>,
    pub file_prefix: PathBuf,
    pub overrides: Option<Value>,
    pub debug: bool,
    pub uid: u32,
    pub gid: u32,
    pub scripts: Option<Scripts>,
}

The Context will be given to all recipes when they are trying to resolve tasks.

Examples

Context has default implementations for every field for maximum flexibility

use wf2_core::context::Context;
use wf2_core::recipes::recipe_kinds::RecipeKinds;
use wf2_core::php::PHP;

let ctx = Context::default();

assert_eq!(ctx.recipe, RecipeKinds::M2);
assert_eq!(ctx.php_version, PHP::SevenThree);

You can also create a context directly from a file

let ctx = Context::new_from_file("../fixtures/config_01.yaml")?;

assert_eq!(ctx.recipe, RecipeKinds::M2);
assert_eq!(ctx.php_version, PHP::SevenThree);
assert_eq!(ctx.domains, vec![String::from("acme.m2")]);
assert_eq!(ctx.npm_path, PathBuf::from("app/code/frontend/Acme/design"));

Fields

recipe: RecipeKinds

cwd: PathBuf

run_mode: RunMode

name: String

domains: Vec<String>

term: Term

pv: Option<String>

npm_path: PathBuf

php_version: PHP

config_path: Option<PathBuf>

env: Option<Value>

file_prefix: PathBuf

overrides: Option<Value>

debug: bool

uid: u32

gid: u32

scripts: Option<Scripts>

Methods

impl Context

pub fn new_from_file(path: impl Into<String>) -> Result<Context, FromFileError>

pub fn new_from_str(yaml_str: &str) -> Result<Context, FromFileError>

pub fn default_domain(&self) -> String

pub fn domains(&self) -> String

pub fn get_context_name(cwd: &PathBuf) -> String

pub fn merge(&mut self, other: ContextOverrides) -> &mut Self

pub fn file_path(&self, filename: &str) -> PathBuf

Trait Implementations

impl Clone for Context

fn clone(&self) -> Context

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Context

fn default() -> Self

Returns the "default value" for a type.

impl Debug for Context

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Context

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

Deserialize this value from the given Serde deserializer.

impl FromFile for Context

fn from_file(input: &str) -> Result<Self, FromFileError> where
    Self: Deserialize<'de>, 

Support serialising to .yml, .yaml & .json files by looking at the file extension and then choosing the correct serde method

fn from_yml_file(input: &str) -> Result<Self, FromFileError> where
    Self: Deserialize<'de>, 

From a string like file:config.yaml, try to read the file and if it exists, parse into a strongly typed struct Self

fn from_json_file(input: &str) -> Result<Self, FromFileError> where
    Self: Deserialize<'de>, 

From a string like file:config.yaml, try to read the file and if it exists, parse into a strongly typed struct Self

fn get_file_path(input: &str) -> Result<String, FromFileError>

Parse strings like file:config.yaml to extract the file path only

fn file_read(input: String) -> Result<String, FromFileError>

Attempt to Read the file's contents into a string

fn from_yaml_string(contents: String) -> Result<Self, FromFileError> where
    Self: Deserialize<'de>, 

Parse any YAML string directly into a Self

fn from_json_string(contents: String) -> Result<Self, FromFileError> where
    Self: Deserialize<'de>, 

Parse json string directly into a Self