Enum malachite_base::unions::Union2

pub enum Union2<A, B> {
    A(A),
    B(B),
}

This is a union, or sum type, of $n$ values. It is essentially a generic enum.

Variants

A(A)

B(B)

Implementations

impl<T> Union2<T, T>

pub fn unwrap(self) -> T

Given a union whose variants all have the same type, unwraps it into a value of that type.

Worst-case complexity

Constant time and additional memory.

Examples

See here.

Trait Implementations

impl<A: Clone, B: Clone> Clone for Union2<A, B>

fn clone(&self) -> Union2<A, B>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<A: Debug, B: Debug> Debug for Union2<A, B>

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

Formats the value using the given formatter.

impl<A: Display, B: Display> Display for Union2<A, B>

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

Converts a union to a String.

Examples

See here.

impl<A: FromStr, B: FromStr> FromStr for Union2<A, B>

fn from_str(src: &str) -> Result<Union2<A, B>, Self::Err>

Converts a string to a union.

If the string does not represent a valid union, an error value is returned.

Examples

See here.

type Err = UnionFromStrError<Union2<<A as FromStr>::Err, <B as FromStr>::Err>>

The associated error which can be returned from parsing.

impl<A: Hash, B: Hash> Hash for Union2<A, B>

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<A: Ord, B: Ord> Ord for Union2<A, B>

fn cmp(&self, other: &Union2<A, B>) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl<A: PartialEq, B: PartialEq> PartialEq for Union2<A, B>

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

fn partial_cmp(&self, other: &Union2<A, B>) -> 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<A: Copy, B: Copy> Copy for Union2<A, B>

impl<A: Eq, B: Eq> Eq for Union2<A, B>

impl<A, B> StructuralPartialEq for Union2<A, B>