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)

pub fn new() -> Self

Empty test data

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

Load test data from a file

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

Overwrite a snapshot

pub fn replace_lines(
    &mut self,
    line_nums: Range<usize>,
    text: &str
) -> Result<(), Error>

Update an inline snapshot

pub fn map_text(self, op: impl FnOnce(&str) -> String) -> Self

Post-process text

See utils

pub fn try_text(self) -> Self

Convert from binary to text, if possible

This will do extra binary file detection if detect-encoding feature flag is set

pub fn make_text(&mut self) -> Result<(), Utf8Error>

Coerce to a string

Note: this will not do a binary-content check

pub fn into_string(self) -> Result<String, Utf8Error>

Coerce to a string

Note: this will not do a binary-content check

pub fn as_str(&self) -> Option<&str>

Return the underlying str

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

pub fn as_bytes(&self) -> &[u8]

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

impl From<String> for Data

fn from(other: String) -> Self

Performs the conversion.

impl From<Vec<u8, Global>> for Data

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

Performs the conversion.

impl PartialEq<Data> 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: &Data) -> bool

This method tests for !=.

impl Eq for Data

impl StructuralEq for Data

impl StructuralPartialEq for Data