Struct PluginCache 

pub struct PluginCache { /* private fields */ }

Content-addressed cache that tracks file hashes so plugins can skip unchanged files across incremental builds.

Stores path → content_hash mappings and persists to .ssg-plugin-cache.json in the site directory.

Implementations

impl PluginCache

pub const fn new() -> Self

Creates an empty cache.

Examples

use ssg::plugin::PluginCache;
use std::path::Path;

let c = PluginCache::new();
assert!(c.has_changed(Path::new("any.path")));

pub fn load(site_dir: &Path) -> Self

Loads a cache from site_dir/.ssg-plugin-cache.json.

Returns an empty cache if the file does not exist or cannot be parsed.

Examples

use ssg::plugin::PluginCache;
use tempfile::tempdir;

let dir = tempdir().unwrap();
// Missing cache file ⇒ empty cache, no error.
let _c = PluginCache::load(dir.path());

pub fn save(&self, site_dir: &Path) -> Result<(), SsgError>

Persists the cache to site_dir/.ssg-plugin-cache.json.

Examples

use ssg::plugin::PluginCache;
use tempfile::tempdir;

let dir = tempdir().unwrap();
PluginCache::new().save(dir.path()).unwrap();
assert!(dir.path().join(".ssg-plugin-cache.json").exists());

pub fn has_changed(&self, path: &Path) -> bool

Returns true if the file at path has changed since the last time it was recorded, or if it has never been recorded.

Examples

use ssg::plugin::PluginCache;
use tempfile::tempdir;
use std::fs;

let dir = tempdir().unwrap();
let f = dir.path().join("x.txt");
fs::write(&f, "a").unwrap();
let mut c = PluginCache::new();
// Never recorded ⇒ has_changed = true.
assert!(c.has_changed(&f));
c.update(&f);
assert!(!c.has_changed(&f));

pub fn update(&mut self, path: &Path)

Records the current content hash for path.

Examples

use ssg::plugin::PluginCache;
use tempfile::tempdir;
use std::fs;

let dir = tempdir().unwrap();
let f = dir.path().join("x.txt");
fs::write(&f, "hi").unwrap();
let mut c = PluginCache::new();
c.update(&f);
assert!(!c.has_changed(&f));

Trait Implementations

impl Clone for PluginCache

fn clone(&self) -> PluginCache

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PluginCache

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

Formats the value using the given formatter.

impl Default for PluginCache

fn default() -> PluginCache

Returns the “default value” for a type.