Struct RegTest 

pub struct RegTest { /* private fields */ }

RegTest is a utility for regression testing by recording and comparing test outputs.

This struct manages regression test data in two modes:

• Write mode: Captures and stores test output data to a file for future regression runs.
• Read mode: Loads previously recorded regression data and compares it with current test output, reporting any mismatches or differences.

Usage

• Use RegTest::new to create a new instance, specifying the file path for regression data.
• Use [regtest] and [regtest_dbg] methods to record or compare values in Display or Debug format.
• When dropped, if in write mode, the struct writes all buffered entries to the specified file.

Example

use regression_test::RegTest;

let mut regtest = RegTest::new("./regtest_data/regression.json").unwrap();
regtest.regtest("some output");
regtest.regtest_dbg(vec![1, 2, 3]);
// Data is written to file when regtest goes out of scope.

Implementations

impl RegTest

pub fn new<P: AsRef<Path>>(path: P) -> Result<Self>

pub fn regtest<T: Display>(&mut self, value: T)

pub fn regtest_dbg<T: Debug>(&mut self, value: T)

Trait Implementations

impl Drop for RegTest

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.