Enum zot::Ot

pub enum Ot<T> {
    One(T),
    Two(T, T),
}

Variants

One(T)

Two(T, T)

Implementations

impl<T> Ot<T>

#[must_use = "if you intended to assert that this has two values, consider `.unwrap_one()` instead"]pub const fn is_one(&self) -> bool

Returns true if the option is a [One] value.

Examples

let x: zot::Ot<u32> = zot::Ot::One(2);
assert_eq!(x.is_one(), true);

let x: zot::Ot<u32> = zot::Ot::Two(2, 3);
assert_eq!(x.is_one(), false);

#[must_use = "if you intended to assert that this has two values, consider `.unwrap_two()` instead"]pub const fn is_two(&self) -> bool

Returns true if the option is a [Two] value.

Examples

let x: zot::Ot<u32> = zot::Ot::One(2);
assert_eq!(x.is_two(), false);

let x: zot::Ot<u32> = zot::Ot::Two(2, 3);
assert_eq!(x.is_two(), true);

#[must_use]pub fn contains<U>(&self, v: &U) -> bool where
    U: PartialEq<T>, 

Returns true if at least one contained value equals the given value.

Examples

let x: zot::Ot<u32> = zot::Ot::One(2);
assert_eq!(x.contains(&2), true);

let x: zot::Ot<u32> = zot::Ot::One(3);
assert_eq!(x.contains(&2), false);

let x: zot::Ot<u32> = zot::Ot::Two(3, 2);
assert_eq!(x.contains(&2), true);

pub const fn as_ref(&self) -> Ot<&T>

Converts from &Ot<T> to Ot<&T>.

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

Converts from &mut Option<T> to Option<&mut T>.

pub fn as_pin_ref(self: Pin<&Self>) -> Ot<Pin<&T>>

Converts from [Pin]<&Ot<T>> to Ot<[Pin]<&T>>.

pub fn as_pin_mut(self: Pin<&mut Self>) -> Ot<Pin<&mut T>>

Converts from [Pin]<&mut Ot<T>> to Ot<[Pin]<&mut T>>.

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

Returns the contained [One] value, consuming the self value.

Panics

Panics if the value is a [Two] with a custom panic message provided by msg.

Examples

let x = zot::Ot::One("value");
assert_eq!(x.expect_one("fruits are healthy"), "value");

let x: zot::Ot<&str> = zot::Ot::Two("value", "value");
x.expect_one("fruits are healthy"); // panics with `fruits are healthy`

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

Returns the contained [Two] value as a (T, T), consuming the self value.

Panics

Panics if the value is a [One] with a custom panic message provided by msg.

Examples

let x = zot::Ot::Two("value", "value");
assert_eq!(x.expect_two("fruits are healthy"), ("value", "value"));

let x: zot::Ot<&str> = zot::Ot::One("value");
x.expect_two("fruits are healthy"); // panics with `fruits are healthy`

pub fn unwrap_one(self) -> T

Returns the contained [One] value, consuming the self value.

Panics

Panics if the self value equals [Two].

Examples

let x = zot::Ot::One("air");
assert_eq!(x.unwrap_one(), "air");

let x: zot::Ot<&str> = zot::Ot::Two("air", "air");
assert_eq!(x.unwrap_one(), "air"); // fails

pub fn unwrap_two(self) -> (T, T)

Returns the contained [Two] value as a (T, T), consuming the self value.

Panics

Panics if the self value equals [One].

Examples

let x = zot::Ot::Two("air", "air");
assert_eq!(x.unwrap_two(), ("air", "air"));

let x: zot::Ot<&str> = zot::Ot::One("air");
assert_eq!(x.unwrap_two(), ("air", "air")); // fails

pub fn unwrap_one_or(self, default: T) -> T

Returns the contained [One] value or a provided default.

Arguments passed to unwrap_one_or are eagerly evaluated; if you are passing the result of a function call, it is recommended to use unwrap_one_or_else, which is lazily evaluated.

Examples

assert_eq!(zot::Ot::One("car").unwrap_one_or("bike"), "car");
assert_eq!(zot::Ot::Two("car", "train").unwrap_one_or("bike"), "bike");

pub fn unwrap_two_or(self, default: (T, T)) -> (T, T)

Returns the contained [Two] value as a (T, T) or a provided default.

Arguments passed to unwrap_two_or are eagerly evaluated; if you are passing the result of a function call, it is recommended to use unwrap_two_or_else, which is lazily evaluated.

Examples

assert_eq!(zot::Ot::Two("car", "train").unwrap_two_or(("bike", "pogo")), ("car", "train"));
assert_eq!(zot::Ot::One("car").unwrap_two_or(("bike", "pogo")), ("bike", "pogo"));

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

Returns the contained [One] value or computes it from a closure.

Examples

let k = 10;
assert_eq!(zot::Ot::One(4).unwrap_one_or_else(|| 2 * k), 4);
assert_eq!(zot::Ot::Two(4, 5).unwrap_one_or_else(|| 2 * k), 20);

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

Returns the contained [Two] value as a (T, T) or computes it from a closure.

Examples

let k = 10;
assert_eq!(zot::Ot::Two(4, 5).unwrap_two_or_else(|| (2 * k, 3 * k)), (4, 5));
assert_eq!(zot::Ot::One(4).unwrap_two_or_else(|| (2 * k, 3 * k)), (20, 30));

pub fn ok_one_or_else<E, F: FnOnce(T, T) -> E>(self, f: F) -> Result<T, E>

Returns a Result with the contained [One] value or computes an Err from a closure.

pub fn ok_two_or_else<E, F: FnOnce(T) -> E>(self, f: F) -> Result<(T, T), E>

Returns a Result with the contained [Two] value as a (T, T) or computes an Err from a closure.

pub fn first(&self) -> &T

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

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

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

pub fn last(&self) -> &T

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

pub fn map<U, F: FnMut(T) -> U>(self, f: F) -> Ot<U>

Maps an Ot<T> to Ot<U> by applying a function to a contained value.

Examples

Converts an Ot<String> into an Ot<usize>, consuming the original:

let ot_string = zot::Ot::Two(String::from("Hello, World!"), String::from("Goodbye, World!"));
// `Ot::map` takes self *by value*, consuming `ot_string`
let ot_len = ot_string.map(|s| s.len());

assert_eq!(ot_len, zot::Ot::Two(13, 15));

pub const fn iter(&self) -> Iter<'_, T>

Returns an iterator over the contained values.

Examples

let x = zot::Ot::Two(4, 5);
let mut iter = x.iter();
assert_eq!(iter.next(), Some(&4));
assert_eq!(iter.next(), Some(&5));

let x = zot::Ot::One(4);
let mut iter = x.iter();
assert_eq!(iter.next(), Some(&4));
assert_eq!(iter.next(), None);

pub fn iter_mut(&mut self) -> IterMut<'_, T>

Returns a mutable iterator over the contained values.

Examples

let mut x = zot::Ot::One(4);
match x.iter_mut().next() {
    Some(v) => *v = 42,
    None => {},
}
assert_eq!(x, zot::Ot::One(42));

pub fn replace_one(&mut self, value: T) -> Ot<T>

Replaces the actual value in the Ot by the value given in parameter, returning the old value, leaving a [One] in its place without deinitializing either one.

Examples

let mut x = zot::Ot::One(2);
let old = x.replace_one(5);
assert_eq!(x, zot::Ot::One(5));
assert_eq!(old, zot::Ot::One(2));

let mut x = zot::Ot::Two(5, 6);
let old = x.replace_one(3);
assert_eq!(x, zot::Ot::One(3));
assert_eq!(old, zot::Ot::Two(5, 6));

pub fn replace_two(&mut self, first: T, second: T) -> Ot<T>

Replaces the actual value in the Ot by the values given in parameter, returning the old value, leaving a [Two] in its place without deinitializing either one.

Examples

let mut x = zot::Ot::One(2);
let old = x.replace_two(5, 6);
assert_eq!(x, zot::Ot::Two(5, 6));
assert_eq!(old, zot::Ot::One(2));

let mut x = zot::Ot::Two(5, 6);
let old = x.replace_two(3, 4);
assert_eq!(x, zot::Ot::Two(3, 4));
assert_eq!(old, zot::Ot::Two(5, 6));

pub fn replace_first(&mut self, value: T) -> T

Replaces the first value in the Ot by the value given in parameter, returning the old value.

Examples

let mut x = zot::Ot::Two(2, 3);
let old = x.replace_first(5);
assert_eq!(x, zot::Ot::Two(5, 3));
assert_eq!(old, 2);

let mut x = zot::Ot::One(2);
let old = x.replace_first(3);
assert_eq!(x, zot::Ot::One(3));
assert_eq!(old, 2);

pub fn replace_last(&mut self, value: T) -> T

Replaces the last value in the Ot by the value given in parameter, returning the old value.

Examples

let mut x = zot::Ot::Two(2, 3);
let old = x.replace_last(5);
assert_eq!(x, zot::Ot::Two(2, 5));
assert_eq!(old, 3);

let mut x = zot::Ot::One(2);
let old = x.replace_last(3);
assert_eq!(x, zot::Ot::One(3));
assert_eq!(old, 2);

pub fn len(&self) -> usize

Returns the number of contained elements.

Examples

let x: zot::Ot<u32> = zot::Ot::Two(7, 20);
assert_eq!(x.len(), 2);

impl<T: Copy> Ot<&T>

pub fn copied(self) -> Ot<T>

Maps an Ot<&T> to an Ot<T> by copying the contents of the ot.

Examples

let x = 12;
let ot_x = zot::Ot::One(&x);
assert_eq!(ot_x, zot::Ot::One(&12));
let copied = ot_x.copied();
assert_eq!(copied, zot::Ot::One(12));

impl<T: Copy> Ot<&mut T>

pub fn copied(self) -> Ot<T>

Maps an Ot<&mut T> to an Ot<T> by copying the contents of the ot.

Examples

let mut x = 12;
let ot_x = zot::Ot::One(&mut x);
assert_eq!(ot_x, zot::Ot::One(&mut 12));
let copied = ot_x.copied();
assert_eq!(copied, zot::Ot::One(12));

impl<T: Clone> Ot<&T>

pub fn cloned(self) -> Ot<T>

Maps an Ot<&T> to an Ot<T> by cloning the contents of the ot.

Examples

let x = 12;
let ot_x = zot::Ot::One(&x);
assert_eq!(ot_x, zot::Ot::One(&12));
let cloned = ot_x.cloned();
assert_eq!(cloned, zot::Ot::One(12));

impl<T: Clone> Ot<&mut T>

pub fn cloned(self) -> Ot<T>

Maps an Ot<&mut T> to an Ot<T> by cloning the contents of the ot.

Examples

let mut x = 12;
let ot_x = zot::Ot::One(&mut x);
assert_eq!(ot_x, zot::Ot::One(&mut 12));
let cloned = ot_x.cloned();
assert_eq!(cloned, zot::Ot::One(12));

impl<T: Deref> Ot<T>

pub fn as_deref(&self) -> Ot<&T::Target>

Converts from Ot<T> (or &Ot<T>) to Ot<&T::Target>.

Leaves the original Ot in-place, creating a new one with a reference to the original one, additionally coercing the contents via [Deref].

Examples

let x: zot::Ot<String> = zot::Ot::One("hey".to_owned());
assert_eq!(x.as_deref(), zot::Ot::One("hey"));

Trait Implementations

impl<T: Clone> Clone for Ot<T>

fn clone(&self) -> Ot<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Copy> Copy for Ot<T>

impl<T: Debug> Debug for Ot<T>

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

Formats the value using the given formatter.

impl<T: Eq> Eq for Ot<T>

impl<'a, T> From<&'a Ot<T>> for Ot<&'a T>

fn from(o: &'a Ot<T>) -> Ot<&'a T>

Converts from &Ot<T> to Ot<&T>.

Examples

let s: zot::Ot<String> = zot::Ot::One(String::from("Hello, Rustaceans!"));
let o: zot::Ot<usize> = zot::Ot::from(&s).map(|ss: &String| ss.len());

println!("Can still print s: {:?}", s);

assert_eq!(o, zot::Ot::One(18));

impl<'a, T> From<&'a mut Ot<T>> for Ot<&'a mut T>

fn from(o: &'a mut Ot<T>) -> Ot<&'a mut T>

Converts from &mut Ot<T> to Ot<&mut T>

Examples

let mut s = zot::Ot::One(String::from("Hello"));
let o: zot::Ot<&mut String> = zot::Ot::from(&mut s);

match o {
    zot::Ot::One(t) => *t = String::from("Hello, Rustaceans!"),
    _ => (),
}

assert_eq!(s, zot::Ot::One(String::from("Hello, Rustaceans!")));

impl<T> From<(T, Option<T>)> for Ot<T>

fn from(ts: (T, Option<T>)) -> Self

Create an Ot from an element and an Option. Returns an Ot::One if the Option was None, otherwise Ot::Two.

Examples

let x = zot::Ot::from((5, Some(2)));
assert_eq!(x, zot::Ot::Two(5, 2));

let x = zot::Ot::from((5, None));
assert_eq!(x, zot::Ot::One(5));

impl<T> From<(T, T)> for Ot<T>

fn from(ts: (T, T)) -> Self

Performs the conversion.

impl<T> From<Ot<T>> for Zot<T>

fn from(ot: Ot<T>) -> Self

Performs the conversion.

impl<T> From<T> for Ot<T>

fn from(t: T) -> Self

Performs the conversion.

impl<T: Hash> Hash for Ot<T>

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl<T> IntoIterator for Ot<T>

type Item = T

The type of the elements being iterated over.

type IntoIter = IntoIter<T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Returns a consuming iterator any contained values.

Examples

let x = zot::Ot::Two("string", "text");
let v: Vec<&str> = x.into_iter().collect();
assert_eq!(v, ["string", "text"]);

let x = zot::Ot::One("string");
let v: Vec<&str> = x.into_iter().collect();
assert_eq!(v, ["string"]);

impl<'a, T> IntoIterator for &'a Ot<T>

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = Iter<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, T> IntoIterator for &'a mut Ot<T>

type Item = &'a mut T

The type of the elements being iterated over.

type IntoIter = IterMut<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: Ord> Ord for Ot<T>

fn cmp(&self, other: &Ot<T>) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq<Ot<T>> for Ot<T>

fn eq(&self, other: &Ot<T>) -> bool

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

fn ne(&self, other: &Ot<T>) -> bool

This method tests for !=.

impl<T: PartialOrd> PartialOrd<Ot<T>> for Ot<T>

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub 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> StructuralEq for Ot<T>

impl<T> StructuralPartialEq for Ot<T>