Struct PluginManager 

pub struct PluginManager { /* private fields */ }

Manages registered plugins and executes lifecycle hooks.

Example

use ssg::plugin::{PluginManager, PluginContext, Plugin};
use ssg::error::SsgError;
use std::path::Path;

#[derive(Debug)]
struct LogPlugin;

impl Plugin for LogPlugin {
    fn name(&self) -> &str { "logger" }
    fn before_compile(&self, ctx: &PluginContext) -> Result<(), SsgError> {
        println!("Compiling from {:?}", ctx.content_dir);
        Ok(())
    }
}

let mut pm = PluginManager::new();
pm.register(LogPlugin);
assert_eq!(pm.len(), 1);

let ctx = PluginContext::new(
    Path::new("content"),
    Path::new("build"),
    Path::new("public"),
    Path::new("templates"),
);
pm.run_before_compile(&ctx).unwrap();

Implementations

impl PluginManager

pub fn new() -> Self

Creates a new empty plugin manager.

Examples

use ssg::plugin::PluginManager;

let pm = PluginManager::new();
assert!(pm.is_empty());

pub fn register<P: Plugin + 'static>(&mut self, plugin: P)

Registers a plugin.

Plugins run in the order they are registered.

Examples

use ssg::drafts::DraftPlugin;
use ssg::plugin::PluginManager;

let mut pm = PluginManager::new();
pm.register(DraftPlugin::new(false));
assert_eq!(pm.len(), 1);

pub fn len(&self) -> usize

Returns the number of registered plugins.

Examples

use ssg::plugin::PluginManager;

let pm = PluginManager::new();
assert_eq!(pm.len(), 0);

pub fn is_empty(&self) -> bool

Returns true if no plugins are registered.

Examples

use ssg::plugin::PluginManager;

assert!(PluginManager::new().is_empty());

pub fn names(&self) -> Vec<&str>

Returns the names of all registered plugins.

Examples

use ssg::drafts::DraftPlugin;
use ssg::plugin::PluginManager;

let mut pm = PluginManager::new();
pm.register(DraftPlugin::new(false));
assert_eq!(pm.names(), vec!["drafts"]);

pub fn inventory(&self) -> Vec<PluginInfo<'_>>

Returns an inventory of every registered plugin, in execution order.

This is the single source of truth for “which plugins run, and what do they do” — consumed by ssg plugins list and by the README sync check, so a plugin added or removed cannot silently leave the documentation claiming a stale count.

Examples

use ssg::drafts::DraftPlugin;
use ssg::plugin::PluginManager;

let mut pm = PluginManager::new();
pm.register(DraftPlugin::new(false));

let inv = pm.inventory();
assert_eq!(inv.len(), 1);
assert_eq!(inv[0].name, "drafts");
assert_eq!(inv[0].order, 0);

pub fn run_before_compile(&self, ctx: &PluginContext) -> Result<(), SsgError>

Runs the before_compile hook on all registered plugins.

Plugins execute in registration order. If any plugin returns an error, execution stops and the error is propagated.

Examples

use ssg::plugin::{PluginContext, PluginManager};
use std::path::Path;

let pm = PluginManager::new();
let ctx = PluginContext::new(
    Path::new("content"), Path::new("build"),
    Path::new("site"), Path::new("templates"),
);
assert!(pm.run_before_compile(&ctx).is_ok());

pub fn run_after_compile(&self, ctx: &PluginContext) -> Result<(), SsgError>

Runs the after_compile hook on all registered plugins.

Plugins execute in registration order. If any plugin returns an error, execution stops and the error is propagated.

Examples

use ssg::plugin::{PluginContext, PluginManager};
use std::path::Path;

let pm = PluginManager::new();
let ctx = PluginContext::new(
    Path::new("content"), Path::new("build"),
    Path::new("site"), Path::new("templates"),
);
assert!(pm.run_after_compile(&ctx).is_ok());

pub fn run_fused_transforms(&self, ctx: &PluginContext) -> Result<(), SsgError>

Runs the fused HTML transform pass: reads each HTML file once, pipes through all plugins with has_transform() == true, writes once.

This eliminates N separate read/write cycles (where N = number of transform plugins) per HTML file.

Examples

use ssg::plugin::{PluginContext, PluginManager};
use std::path::Path;

let pm = PluginManager::new();
let ctx = PluginContext::new(
    Path::new("content"), Path::new("build"),
    Path::new("site"), Path::new("templates"),
);
// No transform plugins ⇒ trivial Ok.
assert!(pm.run_fused_transforms(&ctx).is_ok());

pub fn run_on_serve(&self, ctx: &PluginContext) -> Result<(), SsgError>

Runs the on_serve hook on all registered plugins.

Plugins execute in registration order. If any plugin returns an error, execution stops and the error is propagated.

Examples

use ssg::plugin::{PluginContext, PluginManager};
use std::path::Path;

let pm = PluginManager::new();
let ctx = PluginContext::new(
    Path::new("content"), Path::new("build"),
    Path::new("site"), Path::new("templates"),
);
assert!(pm.run_on_serve(&ctx).is_ok());

Trait Implementations

impl Debug for PluginManager

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

Formats the value using the given formatter.

impl Default for PluginManager

fn default() -> PluginManager

Returns the “default value” for a type.