Struct Yolk

pub struct Yolk { /* private fields */ }

Implementations

impl Yolk

pub fn new(yolk_paths: YolkPaths) -> Self

pub fn init_yolk(&self, yolk_binary: Option<&str>) -> Result<()>

Init or update the yolk directory, setting up the required git structure and files.

yolk_binary is used as the path that git-filter uses when calling yolk to process the files. In most cases, the yolk_binary can be left to None. However, for tests, it should explicitly be provided to ensure that the correct yolk binary is being used.

pub fn init_git_config(&self, yolk_binary: Option<&str>) -> Result<()>

pub fn paths(&self) -> &YolkPaths

pub fn sync_egg_deployment(&self, egg: &Egg) -> Result<bool, MultiError>

Deploy or undeploy the given egg, depending on the current system state and the given Egg data. Returns true if the egg is now deployed, false if it is not.

pub fn cleanup_stale_symlinks_for( &self, egg_name: &str, deployed_symlinks: &[PathBuf], ) -> Result<(), MultiError>

Check through the old symlinks from the cache file of a given egg, and remove any that are not included in the deployed_symlinks list.

pub fn load_egg_configs( &self, eval_ctx: &mut EvalCtx, ) -> Result<HashMap<String, EggConfig>>

fetch the eggs variable from a given EvalCtx.

pub fn sync_to_mode(&self, mode: EvalMode) -> Result<(), MultiError>

First, sync the deployment of all eggs to the local system. Then, update any templated files in the eggs to the given mode.

pub fn prepare_eval_ctx_for_templates(&self, mode: EvalMode) -> Result<EvalCtx>

pub fn eval_template( &self, eval_ctx: &mut EvalCtx, file_path: &str, content: &str, ) -> Result<String>

Evaluate a templated file and return the rendered content.

The file_path is just used for error reporting.

pub fn sync_template_file( &self, eval_ctx: &mut EvalCtx, path: impl AsRef<Path>, ) -> Result<()>

Sync a single template file in place on the filesystem.

pub fn with_canonical_state<T>( &self, f: impl FnOnce() -> Result<T>, ) -> Result<T>

Run a given closure with all templates in their canonical state.

First syncs them to canonical then runs the closure, then syncs them back to local.

pub fn list_eggs(&self) -> Result<Vec<Egg>>

Run the yolk.rhai script, load the egg configs and return a list of all eggs.

pub fn load_egg(&self, egg_name: &str) -> Result<Egg>

Run the yolk.rhai script, load the egg configs and return the requested egg.