Struct SnapshotPlugin 

pub struct SnapshotPlugin { /* private fields */ }

A plugin that captures pipeline state after each phase.

Use this plugin with the --visualize flag to output intermediate representations for debugging and understanding the pipeline.

Example

let snapshot_plugin = SnapshotPlugin::new();
let pipeline = Pipeline::new().plugin(snapshot_plugin.clone());
let ctx = pipeline.run(manifest)?;

// Write snapshots to disk
snapshot_plugin.write_to_dir(".bao/debug")?;

Implementations

impl SnapshotPlugin

pub fn new() -> Self

Create a new snapshot plugin.

pub fn with_output_dir(output_dir: impl Into<PathBuf>) -> Self

Create a new snapshot plugin that writes to a directory.

pub fn snapshots(&self) -> Vec<PhaseSnapshot>

Get all collected snapshots.

pub fn write_to_dir(&self, dir: impl AsRef<Path>) -> Result<()>

Write all snapshots to the configured output directory.

Trait Implementations

impl Default for SnapshotPlugin

fn default() -> Self

Returns the “default value” for a type.

impl Plugin for SnapshotPlugin

fn name(&self) -> &'static str

The name of this plugin (for debugging and logging).

fn on_after_phase( &self, phase: &str, ctx: &mut CompilationContext, ) -> Result<()>

Called after a phase completes successfully.

fn on_before_phase( &self, phase: &str, ctx: &mut CompilationContext, ) -> Result<()>

Called before a phase runs.