Enum proptest::test_runner::FileFailurePersistence

pub enum FileFailurePersistence {
    Off,
    SourceParallel(&'static str),
    WithSource(&'static str),
    Direct(&'static str),
    // some variants omitted
}

Describes how failing test cases are persisted.

Note that file names in this enum are &str rather than &Path since constant functions are not yet in Rust stable as of 2017-12-16.

In all cases, if a derived path references a directory which does not yet exist, proptest will attempt to create all necessary parent directories.

Variants

Off

Completely disables persistence of failing test cases.

This is semantically equivalent to Direct("/dev/null") on Unix and Direct("NUL") on Windows (though it is internally handled by simply not doing any I/O).

SourceParallel(&'static str)

The path given to TestRunner::set_source_file() is parsed. The path is traversed up the directory tree until a directory containing a file named lib.rs or main.rs is found. A sibling to that directory with the name given by the string in this configuration is created, and a file with the same name and path relative to the source directory, but with the extension changed to .txt, is used.

For example, given a source path of /home/jsmith/code/project/src/foo/bar.rs and a configuration of SourceParallel("proptest-regressions") (the default), assuming the src directory has a lib.rs or main.rs, the resulting file would be /home/jsmith/code/project/proptest-regressions/foo/bar.txt.

If no lib.rs or main.rs can be found, a warning is printed and this behaves like WithSource.

If no source file has been configured, a warning is printed and this behaves like Off.

WithSource(&'static str)

The path given to TestRunner::set_source_file() is parsed. The extension of the path is changed to the string given in this configuration, and that filename is used.

For example, given a source path of /home/jsmith/code/project/src/foo/bar.rs and a configuration of WithSource("regressions"), the resulting path would be /home/jsmith/code/project/src/foo/bar.regressions.

Direct(&'static str)

The string given in this option is directly used as a file path without any further processing.

Trait Implementations

impl Clone for FileFailurePersistence

fn clone(&self) -> FileFailurePersistence

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for FileFailurePersistence

impl Debug for FileFailurePersistence

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

Formats the value using the given formatter.

impl PartialEq for FileFailurePersistence

fn eq(&self, other: &FileFailurePersistence) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &FileFailurePersistence) -> bool

This method tests for !=.

impl Default for FileFailurePersistence

fn default() -> Self

Returns the "default value" for a type.

impl FailurePersistence for FileFailurePersistence

Important traits for Vec<u8>

impl Write for Vec<u8>

fn load_persisted_failures(     &self,     source_file: Option<&'static str> ) -> Vec<[u8; 16]>

Supply seeds associated with the given source_file that may be used by a TestRunner's random number generator in order to consistently recreate a previously-failing Strategy-provided value.

fn save_persisted_failure(     &mut self,     source_file: Option<&'static str>,     seed: [u8; 16],     shrunken_value: &Debug )

Store a new failure-generating seed associated with the given source_file.

Important traits for Box<W>

impl<W> Write for Box<W> where
    W: Write + ?Sized, impl<R> Read for Box<R> where
    R: Read + ?Sized, impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

fn box_clone(&self) -> Box<FailurePersistence>

Delegate method for producing a trait object usable with Clone

fn eq(&self, other: &FailurePersistence) -> bool

Equality testing delegate required due to constraints of trait objects.

fn as_any(&self) -> &Any

Assistant method for trait object comparison.