Struct Output 

pub struct Output {
    pub path: PathBuf,
}

Allows defining a cached file output and when it should be rebuilt.

Example usage:

use std::{fs, path::PathBuf};

let output_path = PathBuf::from("my/build/result.txt");

cicero_cache::Output::from(output_path.clone()).rebuild_on_change([
    PathBuf::from("my/build/input.csv"),
], || {
    if output_path.exists() {
        fs::remove_file(&output_path)?;
    }
    if let Some(parent_dir) = output_path.parent() {
        fs::create_dir_all(parent_dir)?;
    }
    fs::File::create(output_path)?;
    Ok(())
});

Fields

path: PathBuf

File path that results from the cached action.

Implementations

impl Output

pub fn rebuild_on_change( &self, inputs: impl AsRef<[PathBuf]>, code: impl FnOnce() -> Result<()>, ) -> Result<()>

Executes the provided closures, if one of the provided inputs or the provided Output::path changed from the previous run.

In this case, the result of the closure is returned as an Ok(Some(_)). If the closure did not get executed, an Ok(None) is returned.

If an error occurs in the provided closure, the result is not cached and the error is returned.

Trait Implementations

impl From<&Path> for Output

fn from(path: &Path) -> Self

Converts to this type from the input type.

impl From<PathBuf> for Output

fn from(path: PathBuf) -> Self

Converts to this type from the input type.