Enum ezomyte::Quasi

#[must_use]
pub enum Quasi<T, S = Json> {
    True(T),
    Substitute(S),
}

Quasi-equivalent wrapper over a deserialized type.

Basically, Quasi<T> is simply wrapping T in the vast majority of cases. The only exception is when T couldn't be deserialized successfully, in which case the original source/subsititute representation (S) is made available.

Because Quasi<T> is essentially T, you'd normally just call the get method and work with the resulting &T reference directly. Alternatively, the wrapper itself offers an Option-like interface for safely accessing T. There is intentionally no equivalent interface to access the subsititute value outside of pattern matching.

Variants

True(T)

The usual, "true" value.

Substitute(S)

The substitute, "fake", undeserialized value.

Methods

impl<T, S> Quasi<T, S>

pub fn expect(self, msg: &str) -> T

Unwraps the container, yielding the underlying value.

Panics

Panics if it's a Substitute with a custom panic message provided by msg.

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn get(&self) -> &T

Get an immutable reference to the underlying type.

Panics

Panics if it's a Substitute.

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn get_mut(&mut self) -> &mut T

Get a mutable reference to the underlying type.

Panics

Panics if it's a Substitute.

pub fn unwrap(self) -> T

Moves the underyling value out of the Quasi container.

Panics

Panics if it's a Substitute.

impl<T, S> Quasi<T, S>

pub fn as_ref(&self) -> Option<&T>

Returns an optional reference to the underlying value.

pub fn as_mut(&mut self) -> Option<&mut T>

Returns an optional mutable reference to the underlying value.

Important traits for Box<W>

impl<W> Write for Box<W> where
    W: Write + ?Sized, impl<R> Read for Box<R> where
    R: Read + ?Sized, impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn iter<'q>(&'q self) -> Box<Iterator<Item = &'q T> + 'q>

Returns an iterator over the one underlying value.

Important traits for Box<W>

impl<W> Write for Box<W> where
    W: Write + ?Sized, impl<R> Read for Box<R> where
    R: Read + ?Sized, impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn iter_mut<'q>(&'q mut self) -> Box<Iterator<Item = &'q mut T> + 'q>

Returns a mutable iterator over the one underlying value.

pub fn unwrap_or(self, def: T) -> T

Returns the underlying value or a default.

pub fn unwrap_or_else<F: FnOnce() -> T>(self, f: F) -> T

Returns the underlying value or computes one from a closure.

impl<T: Default, S> Quasi<T, S>

pub fn unwrap_or_default(self) -> T

Returns the underlying value or a default.

impl<T, S> Quasi<T, S>

pub fn map<U, F: FnOnce(T) -> U>(self, f: F) -> Quasi<U, S>

Maps a Quasi<T> to Quasi<U> by applying a function to the underlying value.

Trait Implementations

impl<T, S> From<T> for Quasi<T, S>

fn from(v: T) -> Self

Performs the conversion.

impl<T: Default, S> Default for Quasi<T, S>

fn default() -> Self

Returns the "default value" for a type.

impl<'de, T, S> Deserialize<'de> for Quasi<T, S> where
    T: Deserialize<'de>,
    S: Clone + Deserialize<'de> + IntoDeserializer<'de>, 

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

Deserialize this value from the given Serde deserializer.

impl<T: FromStr> FromStr for Quasi<T, String>

type Err = NoError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl<T, S> Serialize for Quasi<T, S> where
    T: Serialize,
    S: Serialize, 

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

Serialize this value into the given Serde serializer.

impl<T, S> Clone for Quasi<T, S> where
    T: Clone,
    S: Clone, 

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, S> PartialEq for Quasi<T, S> where
    T: PartialEq,
    S: PartialEq, 

fn eq(&self, other: &Self) -> 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 !=.

impl<T, S> PartialOrd for Quasi<T, S> where
    T: PartialOrd,
    S: PartialOrd, 

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<T, S> Into<Option<T>> for Quasi<T, S>

fn into(self) -> Option<T>

Performs the conversion.

impl<T, S> Into<Result<T, S>> for Quasi<T, S>

fn into(self) -> Result<T, S>

Performs the conversion.

impl<T, S> Debug for Quasi<T, S> where
    T: Debug,
    S: Debug, 

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

Formats the value using the given formatter.

impl<T, S> Display for Quasi<T, S> where
    T: Display,
    S: Display, 

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

Formats the value using the given formatter.