Struct snapbox::assert::Assert

pub struct Assert { /* private fields */ }

Snapshot assertion against a file’s contents

Useful for one-off assertions with the snapshot stored in a file

Examples

let actual = "something";
Assert::new().eq(actual, file!["output.txt"]);

Implementations

impl Assert

Assertions

pub fn new() -> Self

pub fn eq(&self, actual: impl IntoData, expected: impl IntoData)

Check if a value is the same as an expected value

By default filters are applied, including:

• ... is a line-wildcard when on a line by itself
• [..] is a character-wildcard when inside a line
• [EXE] matches .exe on Windows
• "{...}" is a JSON value wildcard
• "...": "{...}" is a JSON key-value wildcard
• \ to /
• Newlines

To limit this to newline normalization for text, call Data::raw on expected.

Examples

let actual = "something";
let expected = "so[..]g";
Assert::new().eq(actual, expected);

Can combine this with file!

let actual = "something";
Assert::new().eq(actual, file!["output.txt"]);

pub fn eq_(&self, actual: impl IntoData, expected: impl IntoData)

👎Deprecated since 0.6.0: Replaced with Assert::eq

pub fn try_eq( &self, actual_name: Option<&dyn Display>, actual: Data, expected: Data ) -> Result<()>

impl Assert

Directory Assertions

pub fn subset_eq( &self, expected_root: impl Into<PathBuf>, actual_root: impl Into<PathBuf> )

Available on crate feature dir only.

pub fn subset_matches( &self, pattern_root: impl Into<PathBuf>, actual_root: impl Into<PathBuf> )

Available on crate feature dir only.

impl Assert

Customize Behavior

pub fn palette(self, palette: Palette) -> Self

Override the color palette

pub fn action_env(self, var_name: &str) -> Self

Read the failure action from an environment variable

pub fn action(self, action: Action) -> Self

Override the failure action

pub fn redact_with(self, substitutions: Redactions) -> Self

Override the default Redactions

pub fn substitutions(self, substitutions: Redactions) -> Self

👎Deprecated since 0.6.2: Replaced with Assert::redact_with

Override the default Redactions

pub fn normalize_paths(self, yes: bool) -> Self

Specify whether text should have path separators normalized

The default is normalized

impl Assert

pub fn selected_action(&self) -> Action

Trait Implementations

impl Clone for Assert

fn clone(&self) -> Assert

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Assert

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

Formats the value using the given formatter.

impl Default for Assert

fn default() -> Self

Returns the “default value” for a type.