Struct snapbox::Data

pub struct Data { /* private fields */ }

Test fixture, actual output, or expected result

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

Implementations

impl Data

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

Mark the data as binary (no post-processing)

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

Mark the data as text (post-processing)

Examples found in repository

examples/diff.rs (line 10)

fn main() {
    let mut args = std::env::args();
    let _ = args.next().expect("expects `$ diff <old> <new>`");
    let old_path = args.next().expect("expects `$ diff <old> <new>`");
    let new_path = args.next().expect("expects `$ diff <old> <new>`");
    if args.next().is_some() {
        panic!("expects `$ diff <old> <new>`");
    }

    let old = snapbox::Data::text(std::fs::read_to_string(&old_path).unwrap());
    let new = snapbox::Data::text(std::fs::read_to_string(&new_path).unwrap());

    let mut output = String::new();
    snapbox::report::write_diff(
        &mut output,
        &old,
        &new,
        Some(&old_path),
        Some(&new_path),
        snapbox::report::Palette::color(),
    )
    .unwrap();
    println!("{output}");
}

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

Available on crate feature json only.

pub fn new() -> Self

Empty test data

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

Load test data from a file

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

Overwrite a snapshot

pub fn normalize(self, op: impl Normalize) -> Self

Post-process text

See utils

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) -> Vec<u8>

pub fn try_coerce(self, format: DataFormat) -> Self

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 copy 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

Formats the value using the given formatter.

impl Default for Data

fn default() -> Self

Returns the “default value” for a type.

impl Display for Data

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

Formats the value using the given formatter.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl From<String> for Data

fn from(other: String) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for Data

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

Converts to this type from the input type.

impl PartialEq for Data

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

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

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

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

impl Eq for Data

impl StructuralPartialEq for Data