Struct Goldrust

pub struct Goldrust {
    pub golden_file_path: PathBuf,
    pub response_source: ResponseSource,
    pub save_check: bool,
    /* private fields */
}

Fields

golden_file_path: PathBuf

The path to the golden file, which was automatically generated based on the thread name of the test

response_source: ResponseSource

save_check: bool

Implementations

impl Goldrust

pub fn new(function_name: &str) -> Self

Create a new instance of GoldrustBuilder

A new instance of Goldrust should be created for each test.

Golden file names are based on the thread name of the test. (e.g. test::test_name → test-test_name.json)

pub fn save<T>(&mut self, content: T) -> Result<(), Error>

where for<'de> T: Serialize + Deserialize<'de> + Debug,

Save content to the golden file

This method should be called when required, or Goldrust will panic when dropped.

Trait Implementations

impl Clone for Goldrust

fn clone(&self) -> Goldrust

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Goldrust

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Goldrust

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Goldrust

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

Formats the value using the given formatter.

impl Drop for Goldrust

This ensures that the content is saved to the golden file when an update is required.

fn drop(&mut self)

Executes the destructor for this type.

impl Ord for Goldrust

fn cmp(&self, other: &Goldrust) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Goldrust

fn eq(&self, other: &Goldrust) -> 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 PartialOrd for Goldrust

fn partial_cmp(&self, other: &Goldrust) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Goldrust

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Goldrust

impl StructuralPartialEq for Goldrust