Struct Data 

pub struct Data {
    pub(crate) inner: Box<DataInner>,
}

Test fixture, actual output, or expected result

This provides conveniences for tracking the intended format (binary vs text).

Fields

inner: Box<DataInner>

Implementations

impl Data

Constructors

See also

• str! for inline snapshots
• file! for external snapshots
• ToString for verifying a Display representation
• ToDebug for verifying a debug representation
• IntoJson for verifying the serde representation
• IntoData for modifying expected

pub fn binary(raw: impl Into<Vec<u8>>) -> Data

Mark the data as binary (no post-processing)

pub fn text(raw: impl Into<String>) -> Data

Mark the data as text (post-processing)

pub fn json(raw: impl Into<Value>) -> Data

pub fn jsonlines(raw: impl Into<Vec<Value>>) -> Data

pub fn new() -> Data

Empty test data

pub fn read_from(path: &Path, data_format: Option<DataFormat>) -> Data

Load expected data from a file

pub fn raw(self) -> Data

Remove default filters from this expected result

pub fn unordered(self) -> Data

Treat lines and json arrays as unordered

impl Data

Assertion frameworks operations

For example, see OutputAssert

pub fn try_read_from( path: &Path, data_format: Option<DataFormat>, ) -> Result<Data, Error>

Load expected data from a file

pub fn write_to(&self, source: &DataSource) -> Result<(), Error>

Overwrite a snapshot

pub fn write_to_path(&self, path: &Path) -> Result<(), Error>

Overwrite a snapshot

pub fn render(&self) -> Option<String>

Return the underlying String

Note: this will not inspect binary data for being a valid String.

pub fn to_bytes(&self) -> Result<Vec<u8>, Error>

pub fn is(self, format: DataFormat) -> Data

Initialize Self as format or Error

This is generally used for expected data

pub fn coerce_to(self, format: DataFormat) -> Data

Convert Self to format if possible

This is generally used on actual data to make it match expected

pub fn source(&self) -> Option<&DataSource>

Location the data came from

pub fn format(&self) -> DataFormat

Outputs the current DataFormat of the underlying data

Trait Implementations

impl Clone for Data

fn clone(&self) -> Data

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Data

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

Formats the value using the given formatter.

impl Default for Data

fn default() -> Data

Returns the “default value” for a type.

impl Display for Data

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

Formats the value using the given formatter.

impl<'b> From<&'b [u8]> for Data

fn from(other: &'b [u8]) -> Data

Converts to this type from the input type.

impl<'d> From<&'d Data> for Data

fn from(other: &'d Data) -> Data

Converts to this type from the input type.

impl<'s> From<&'s String> for Data

fn from(other: &'s String) -> Data

Converts to this type from the input type.

impl<'s> From<&'s str> for Data

fn from(other: &'s str) -> Data

Converts to this type from the input type.

impl From<Inline> for Data

fn from(other: Inline) -> Data

Converts to this type from the input type.

impl From<String> for Data

fn from(other: String) -> Data

Converts to this type from the input type.

impl From<Vec<u8>> for Data

fn from(other: Vec<u8>) -> Data

Converts to this type from the input type.

impl IntoData for &Data

fn into_data(self) -> Data

Convert to Data, applying defaults

fn raw(self) -> Data

Remove default filters from this expected result

fn unordered(self) -> Data

Treat lines and json arrays as unordered

fn is(self, format: DataFormat) -> Data

Initialize as format or Error

fn is_json(self) -> Data

Initialize as json or Error

fn json(self) -> Data

👎Deprecated since 0.6.13:

Replaced with IntoData::is_json

fn is_jsonlines(self) -> Data

Initialize as json lines or Error

fn json_lines(self) -> Data

👎Deprecated since 0.6.13:

Replaced with IntoData::is_jsonlines

fn is_termsvg(self) -> Data

Initialize as Term SVG

fn term_svg(self) -> Data

👎Deprecated since 0.6.13:

Replaced with IntoData::is_termsvg

fn against(self, format: DataFormat) -> Data

Override the type this snapshot will be compared against

fn against_json(self) -> Data

Initialize as json or Error

fn against_jsonlines(self) -> Data

Initialize as json lines or Error

impl IntoData for Data

fn into_data(self) -> Data

Convert to Data, applying defaults

fn raw(self) -> Data

Remove default filters from this expected result

fn unordered(self) -> Data

Treat lines and json arrays as unordered

fn is(self, format: DataFormat) -> Data

Initialize as format or Error

fn is_json(self) -> Data

Initialize as json or Error

fn json(self) -> Data

👎Deprecated since 0.6.13:

Replaced with IntoData::is_json

fn is_jsonlines(self) -> Data

Initialize as json lines or Error

fn json_lines(self) -> Data

👎Deprecated since 0.6.13:

Replaced with IntoData::is_jsonlines

fn is_termsvg(self) -> Data

Initialize as Term SVG

fn term_svg(self) -> Data

👎Deprecated since 0.6.13:

Replaced with IntoData::is_termsvg

fn against(self, format: DataFormat) -> Data

Override the type this snapshot will be compared against

fn against_json(self) -> Data

Initialize as json or Error

fn against_jsonlines(self) -> Data

Initialize as json lines or Error

impl PartialEq for Data

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Data

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 8 bytes