Enum term_transcript::test::UpdateMode

#[non_exhaustive]
pub enum UpdateMode {
    Never,
    Always,
}

Available on crate features test and svg only.

Strategy for saving a new snapshot on a test failure within TestConfig::test() and related methods.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Never

Never create a new snapshot on test failure.

Always

Always create a new snapshot on test failure.

Implementations

impl UpdateMode

pub fn from_env() -> Self

Reads the update mode from the TERM_TRANSCRIPT_UPDATE env variable.

If the TERM_TRANSCRIPT_UPDATE variable is not set, the output depends on whether the executable is running in CI (which is detected by the presence of the CI env variable):

• In CI, the method returns Self::Never.
• Otherwise, the method returns Self::Always.

Panics

If the TERM_TRANSCRIPT_UPDATE env variable is set to an unrecognized value (something other than never or always), this method will panic.

Trait Implementations

impl Clone for UpdateMode

fn clone(&self) -> UpdateMode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateMode

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

Formats the value using the given formatter.

impl Hash for UpdateMode

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<UpdateMode> for UpdateMode

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

impl Eq for UpdateMode

impl StructuralEq for UpdateMode

impl StructuralPartialEq for UpdateMode