Struct EggConfig

pub struct EggConfig {
    pub targets: HashMap<PathBuf, PathBuf>,
    pub enabled: bool,
    pub templates: HashSet<PathBuf>,
    pub main_file: Option<PathBuf>,
    pub strategy: DeploymentStrategy,
}

Fields

targets: HashMap<PathBuf, PathBuf>

The targets map is a map from path-relative-to-egg-dir -> path-where-it-should-go.

enabled: bool

templates: HashSet<PathBuf>

main_file: Option<PathBuf>

The “main” file of this egg – currently used to determine which path should be opened by yolk edit.

strategy: DeploymentStrategy

Implementations

impl EggConfig

pub fn new(in_egg: impl AsRef<Path>, deployed_to: impl AsRef<Path>) -> Self

pub fn new_merge( in_egg: impl AsRef<Path>, deployed_to: impl AsRef<Path>, ) -> Self

pub fn with_enabled(self, enabled: bool) -> Self

pub fn with_template(self, template: impl AsRef<Path>) -> Self

pub fn with_strategy(self, strategy: DeploymentStrategy) -> Self

pub fn with_main_file(self, main_file: impl AsRef<Path>) -> Self

pub fn with_target( self, in_egg: impl AsRef<Path>, deploy_to: impl AsRef<Path>, ) -> Self

Add a new target from a path inside the egg dir to the path it should be deployed as.

pub fn targets_expanded( &self, home: impl AsRef<Path>, egg_root: impl AsRef<Path>, ) -> Result<HashMap<PathBuf, PathBuf>>

Returns the targets map, but with any ~ expanded to the home directory.

The targets map is a map from path-relative-to-egg-dir -> path-where-it-should-go.

pub fn templates_globexpanded( &self, in_dir: impl AsRef<Path>, ) -> Result<Vec<PathBuf>>

Expand the glob patterns in the templates field to a list of paths. The globbed paths are considered relative to in_dir. The resulting list of paths will contain absolute paths.

pub fn from_dynamic(value: Dynamic) -> Result<Self, RhaiError>

Trait Implementations

impl Clone for EggConfig

fn clone(&self) -> EggConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EggConfig

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

Formats the value using the given formatter.

impl Default for EggConfig

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for EggConfig

fn eq(&self, other: &EggConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for EggConfig

impl StructuralPartialEq for EggConfig