Struct egress::Artifact

pub struct Artifact { /* fields omitted */ }

An Artifact is the main object that Egress uses to handle and compare data produced from your tests. It's basically just a map from string keys to Entrys.

Methods

impl Artifact

pub fn new() -> Self

Create an empty Artifact. This is useful for building tree-structured artifacts, but the root artifact for a given test should always come from Egress::artifact.

pub fn insert(&mut self, name: &str, entry: Entry)

Insert an Entry into the artifact, with a given string name. The other insert_* methods are just convenient wrappers around this one.

pub fn insert_debug<T: Debug>(&mut self, name: &str, value: &T)

Convert a value to a string via the fmt::Debug formatter and then insert that into the Artifact with the given string key.

pub fn insert_display<T: Display>(&mut self, name: &str, value: &T)

Convert a value to a string via the fmt::Display formatter and then insert that into the Artifact with the given string key.

pub fn insert_serialize<T: Serialize>(
    &mut self,
    name: &str,
    value: &T
) -> Result<(), ErrorKind>

Convert a value to a JSON value via serde_json and then insert that into the Artifact with the given string key.

Egress uses serde to do this, so if you want to be able to have nicely formatted diffs between your types, you'll want them to derive serde::{Serialize}.

pub fn insert_json(&mut self, name: &str, json_value: Value)

Insert a JSON Value into the Artifact with the given string key.

Trait Implementations

impl Clone for Artifact

fn clone(&self) -> Artifact

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Artifact

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

Formats the value using the given formatter.

impl Default for Artifact

fn default() -> Artifact

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for Artifact

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<Artifact> for Artifact

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

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

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

This method tests for !=.

impl Serialize for Artifact

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Artifact