Struct PetriLogSource 

pub struct PetriLogSource(/* private fields */);

A source of PetriLogFile log files for test output.

Implementations

impl PetriLogSource

pub fn log_file(&self, name: &str) -> Result<PetriLogFile>

Returns a log file for the given name.

The name should not have an extension; .log will be appended automatically.

pub fn create_attachment(&self, filename: &str) -> Result<File>

Creates a file with the given name and returns a handle to it.

If the file already exists, a unique name is generated by appending a number to the base name.

pub fn write_attachment( &self, filename: &str, data: impl Read, ) -> Result<PathBuf>

Writes the given data to a file with the given name.

If the file already exists, a unique name is generated by appending a number to the base name.

pub fn copy_attachment( &self, attachment_filename: &str, source_path: &Path, ) -> Result<()>

Copies the given file path to a file with the given name.

If the file already exists, a unique name is generated by appending a number to the base name.

pub fn log_test_start(&self, name: &str)

Records that a test with the given name is running in this directory.

This is written up front, before the test body runs, so that tooling can identify the test even if the process never gets as far as Self::log_test_result – because it was killed by a timeout, or crashed hard enough to skip unwinding. A directory with this file but no result marker is a test that died without reporting.

pub fn log_test_result(&self, r: &Result<()>, unstable: bool)

Traces and logs the result of a test run in the format expected by our tooling.

pub fn output_dir(&self) -> &Path

Returns the output directory for log files.

Trait Implementations

impl Clone for PetriLogSource

fn clone(&self) -> PetriLogSource

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PetriLogSource

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

Formats the value using the given formatter.