Struct RecordingProgressSink 

pub struct RecordingProgressSink { /* private fields */ }

Recording progress sink - captures events for testing.

This implementation records all progress events to an internal vector, allowing tests to verify that progress reporting is working correctly.

Thread Safety

The internal event vector is protected by a Mutex, making this safe to use with parallel analysis. However, the order of events may not be deterministic when multiple threads are reporting simultaneously.

Example

use debtmap::progress::implementations::{RecordingProgressSink, ProgressEvent};
use debtmap::progress::traits::ProgressSink;

let recorder = RecordingProgressSink::new();

recorder.start_stage("Test");
recorder.report("Test", 0, 5);
recorder.complete_stage("Test");

assert_eq!(recorder.stages(), vec!["Test"]);
assert!(recorder.events().iter().any(|e| matches!(e, ProgressEvent::Report { .. })));

Implementations

impl RecordingProgressSink

pub fn new() -> Self

Create a new recording progress sink.

pub fn events(&self) -> Vec<ProgressEvent>

Get all recorded events.

Returns a clone of the internal event vector.

pub fn stages(&self) -> Vec<String>

Get all stage names that were started.

This is a convenience method for testing that extracts just the stage names from StartStage events.

Example

use debtmap::progress::implementations::RecordingProgressSink;
use debtmap::progress::traits::ProgressSink;

let recorder = RecordingProgressSink::new();
recorder.start_stage("Stage 1");
recorder.start_stage("Stage 2");

assert_eq!(recorder.stages(), vec!["Stage 1", "Stage 2"]);

pub fn completed_stages(&self) -> Vec<String>

Get all completed stage names.

This is a convenience method for testing that extracts just the stage names from CompleteStage events.

pub fn warnings(&self) -> Vec<String>

Get all warnings.

This is a convenience method for testing that extracts just the warning messages.

pub fn clear(&self)

Clear all recorded events.

Useful for resetting state between test cases.

pub fn event_count(&self) -> usize

Get the number of recorded events.

Trait Implementations

impl Clone for RecordingProgressSink

fn clone(&self) -> RecordingProgressSink

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RecordingProgressSink

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

Formats the value using the given formatter.

impl Default for RecordingProgressSink

fn default() -> RecordingProgressSink

Returns the “default value” for a type.

impl ProgressSink for RecordingProgressSink

fn report(&self, stage: &str, current: usize, total: usize)

Report progress for a named stage.

fn start_stage(&self, name: &str)

Report a sub-stage starting.

fn complete_stage(&self, name: &str)

Report a stage completing.

fn warn(&self, message: &str)

Report a warning without interrupting progress.

fn child(&self, _prefix: &str) -> Arc<dyn ProgressSink>

Create a child sink for nested progress.