Struct insta::Settings

pub struct Settings { /* fields omitted */ }

Configures how insta operates at test time.

Settings are always bound to a thread and some default settings are always available. Settings can be either temporarily bound of permanently.

This can be used to influence how the snapshot macros operate. For instance it can be useful to force ordering of maps when unordered structures are used through settings.

Settings can also be configured with the with_settings! macro.

Example:

use insta;

let mut settings = insta::Settings::new();
settings.set_sort_maps(true);
settings.bind(|| {
    insta::assert_snapshot!(...);
});

Methods

impl Settings

pub fn new() -> Settings

Returns the default settings.

pub fn set_sort_maps(&mut self, value: bool)

Enables forceful sorting of maps before serialization.

Note that this only applies to snapshots that undergo serialization (eg: does not work for assert_debug_snapshot!.)

The default value is false.

pub fn sort_maps(&self) -> bool

Returns the current value for map sorting.

pub fn add_redaction<R: Into<Redaction>>(
    &mut self,
    selector: &str,
    replacement: R
)

Registers redactions that should be applied.

This can be useful if redactions must be shared across multiple snapshots.

Note that this only applies to snapshots that undergo serialization (eg: does not work for assert_debug_snapshot!.)

pub fn add_dynamic_redaction<I, F>(&mut self, selector: &str, func: F) where
    I: Into<Content>,
    F: Fn(Content, ContentPath) -> I + Send + Sync + 'static, 

Registers a replacement callback.

This works similar to a redaction but instead of changing the value it asserts the value at a certain place. This function is internally supposed to call things like assert_eq!.

This is a shortcut to add_redaction(dynamic_redaction(...));

pub fn set_redactions<R: Into<Redactions>>(&mut self, redactions: R)

Replaces the currently set redactions.

The default set is empty.

pub fn clear_redactions(&mut self)

Removes all redactions.

pub fn set_snapshot_path<P: AsRef<Path>>(&mut self, path: P)

Sets the snapshot path.

If not absolute it's relative to where the test is in.

Defaults to snapshots.

pub fn snapshot_path(&self) -> &Path

Returns the snapshot path.

pub fn bind<F: FnOnce()>(&self, f: F)

Runs a function with the current settings bound to the thread.

pub fn bind_to_thread(&self)

Binds the settings to the current thread permanently.

Trait Implementations

impl Clone for Settings

fn clone(&self) -> Settings

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Settings

fn default() -> Settings

Returns the "default value" for a type.