Enum futures_util::future::Either [−][src]
pub enum Either<L, R> { Left(L), Right(R), }
The enum Either
with variants Left
and Right
is a general purpose
sum type with two cases.
The Either
type is symmetric and treats its variants the same way, without
preference.
(For representing success or error, use the regular Result
enum instead.)
Variants
Left(L)
A value of type L
.
Right(R)
A value of type R
.
Methods
impl<L, R> Either<L, R>
[src]
impl<L, R> Either<L, R>
pub fn is_left(&self) -> bool
[src]
pub fn is_left(&self) -> bool
Return true if the value is the Left
variant.
use either::*; let values = [Left(1), Right("the right value")]; assert_eq!(values[0].is_left(), true); assert_eq!(values[1].is_left(), false);
pub fn is_right(&self) -> bool
[src]
pub fn is_right(&self) -> bool
Return true if the value is the Right
variant.
use either::*; let values = [Left(1), Right("the right value")]; assert_eq!(values[0].is_right(), false); assert_eq!(values[1].is_right(), true);
pub fn left(self) -> Option<L>
[src]
pub fn left(self) -> Option<L>
Convert the left side of Either<L, R>
to an Option<L>
.
use either::*; let left: Either<_, ()> = Left("some value"); assert_eq!(left.left(), Some("some value")); let right: Either<(), _> = Right(321); assert_eq!(right.left(), None);
pub fn right(self) -> Option<R>
[src]
pub fn right(self) -> Option<R>
Convert the right side of Either<L, R>
to an Option<R>
.
use either::*; let left: Either<_, ()> = Left("some value"); assert_eq!(left.right(), None); let right: Either<(), _> = Right(321); assert_eq!(right.right(), Some(321));
ⓘImportant traits for Either<L, R>pub fn as_ref(&self) -> Either<&L, &R>
[src]
pub fn as_ref(&self) -> Either<&L, &R>
Convert &Either<L, R>
to Either<&L, &R>
.
use either::*; let left: Either<_, ()> = Left("some value"); assert_eq!(left.as_ref(), Left(&"some value")); let right: Either<(), _> = Right("some value"); assert_eq!(right.as_ref(), Right(&"some value"));
ⓘImportant traits for Either<L, R>pub fn as_mut(&mut self) -> Either<&mut L, &mut R>
[src]
pub fn as_mut(&mut self) -> Either<&mut L, &mut R>
Convert &mut Either<L, R>
to Either<&mut L, &mut R>
.
use either::*; fn mutate_left(value: &mut Either<u32, u32>) { if let Some(l) = value.as_mut().left() { *l = 999; } } let mut left = Left(123); let mut right = Right(123); mutate_left(&mut left); mutate_left(&mut right); assert_eq!(left, Left(999)); assert_eq!(right, Right(123));
ⓘImportant traits for Either<L, R>pub fn flip(self) -> Either<R, L>
[src]
pub fn flip(self) -> Either<R, L>
Convert Either<L, R>
to Either<R, L>
.
use either::*; let left: Either<_, ()> = Left(123); assert_eq!(left.flip(), Right(123)); let right: Either<(), _> = Right("some value"); assert_eq!(right.flip(), Left("some value"));
ⓘImportant traits for Either<L, R>pub fn map_left<F, M>(self, f: F) -> Either<M, R> where
F: FnOnce(L) -> M,
[src]
pub fn map_left<F, M>(self, f: F) -> Either<M, R> where
F: FnOnce(L) -> M,
Apply the function f
on the value in the Left
variant if it is present rewrapping the
result in Left
.
use either::*; let left: Either<_, u32> = Left(123); assert_eq!(left.map_left(|x| x * 2), Left(246)); let right: Either<u32, _> = Right(123); assert_eq!(right.map_left(|x| x * 2), Right(123));
ⓘImportant traits for Either<L, R>pub fn map_right<F, S>(self, f: F) -> Either<L, S> where
F: FnOnce(R) -> S,
[src]
pub fn map_right<F, S>(self, f: F) -> Either<L, S> where
F: FnOnce(R) -> S,
Apply the function f
on the value in the Right
variant if it is present rewrapping the
result in Right
.
use either::*; let left: Either<_, u32> = Left(123); assert_eq!(left.map_right(|x| x * 2), Left(123)); let right: Either<u32, _> = Right(123); assert_eq!(right.map_right(|x| x * 2), Right(246));
pub fn either<F, G, T>(self, f: F, g: G) -> T where
F: FnOnce(L) -> T,
G: FnOnce(R) -> T,
[src]
pub fn either<F, G, T>(self, f: F, g: G) -> T where
F: FnOnce(L) -> T,
G: FnOnce(R) -> T,
Apply one of two functions depending on contents, unifying their result. If the value is
Left(L)
then the first function f
is applied; if it is Right(R)
then the second
function g
is applied.
use either::*; fn square(n: u32) -> i32 { (n * n) as i32 } fn negate(n: i32) -> i32 { -n } let left: Either<u32, i32> = Left(4); assert_eq!(left.either(square, negate), 16); let right: Either<u32, i32> = Right(-4); assert_eq!(right.either(square, negate), 4);
pub fn either_with<Ctx, F, G, T>(self, ctx: Ctx, f: F, g: G) -> T where
F: FnOnce(Ctx, L) -> T,
G: FnOnce(Ctx, R) -> T,
[src]
pub fn either_with<Ctx, F, G, T>(self, ctx: Ctx, f: F, g: G) -> T where
F: FnOnce(Ctx, L) -> T,
G: FnOnce(Ctx, R) -> T,
Like either
, but provide some context to whichever of the
functions ends up being called.
// In this example, the context is a mutable reference use either::*; let mut result = Vec::new(); let values = vec![Left(2), Right(2.7)]; for value in values { value.either_with(&mut result, |ctx, integer| ctx.push(integer), |ctx, real| ctx.push(f64::round(real) as i32)); } assert_eq!(result, vec![2, 3]);
ⓘImportant traits for Either<L, R>pub fn left_and_then<F, S>(self, f: F) -> Either<S, R> where
F: FnOnce(L) -> Either<S, R>,
[src]
pub fn left_and_then<F, S>(self, f: F) -> Either<S, R> where
F: FnOnce(L) -> Either<S, R>,
Apply the function f
on the value in the Left
variant if it is present.
use either::*; let left: Either<_, u32> = Left(123); assert_eq!(left.left_and_then::<_,()>(|x| Right(x * 2)), Right(246)); let right: Either<u32, _> = Right(123); assert_eq!(right.left_and_then(|x| Right::<(), _>(x * 2)), Right(123));
ⓘImportant traits for Either<L, R>pub fn right_and_then<F, S>(self, f: F) -> Either<L, S> where
F: FnOnce(R) -> Either<L, S>,
[src]
pub fn right_and_then<F, S>(self, f: F) -> Either<L, S> where
F: FnOnce(R) -> Either<L, S>,
Apply the function f
on the value in the Right
variant if it is present.
use either::*; let left: Either<_, u32> = Left(123); assert_eq!(left.right_and_then(|x| Right(x * 2)), Left(123)); let right: Either<u32, _> = Right(123); assert_eq!(right.right_and_then(|x| Right(x * 2)), Right(246));
ⓘImportant traits for Either<L, R>pub fn into_iter(
self
) -> Either<<L as IntoIterator>::IntoIter, <R as IntoIterator>::IntoIter> where
L: IntoIterator,
R: IntoIterator<Item = <L as IntoIterator>::Item>,
[src]
pub fn into_iter(
self
) -> Either<<L as IntoIterator>::IntoIter, <R as IntoIterator>::IntoIter> where
L: IntoIterator,
R: IntoIterator<Item = <L as IntoIterator>::Item>,
Convert the inner value to an iterator.
use either::*; let left: Either<_, Vec<u32>> = Left(vec![1, 2, 3, 4, 5]); let mut right: Either<Vec<u32>, _> = Right(vec![]); right.extend(left.into_iter()); assert_eq!(right, Right(vec![1, 2, 3, 4, 5]));
impl<T, L, R> Either<(T, L), (T, R)>
[src]
impl<T, L, R> Either<(T, L), (T, R)>
pub fn factor_first(self) -> (T, Either<L, R>)
[src]
pub fn factor_first(self) -> (T, Either<L, R>)
Factor out a homogeneous type from an either of pairs.
Here, the homogeneous type is the first element of the pairs.
use either::*; let left: Either<_, (u32, String)> = Left((123, vec![0])); assert_eq!(left.factor_first().0, 123); let right: Either<(u32, Vec<u8>), _> = Right((123, String::new())); assert_eq!(right.factor_first().0, 123);
impl<T, L, R> Either<(L, T), (R, T)>
[src]
impl<T, L, R> Either<(L, T), (R, T)>
pub fn factor_second(self) -> (Either<L, R>, T)
[src]
pub fn factor_second(self) -> (Either<L, R>, T)
Factor out a homogeneous type from an either of pairs.
Here, the homogeneous type is the second element of the pairs.
use either::*; let left: Either<_, (String, u32)> = Left((vec![0], 123)); assert_eq!(left.factor_second().1, 123); let right: Either<(Vec<u8>, u32), _> = Right((String::new(), 123)); assert_eq!(right.factor_second().1, 123);
impl<T> Either<T, T>
[src]
impl<T> Either<T, T>
pub fn into_inner(self) -> T
[src]
pub fn into_inner(self) -> T
Extract the value of an either over two equivalent types.
use either::*; let left: Either<_, u32> = Left(123); assert_eq!(left.into_inner(), 123); let right: Either<u32, _> = Right(123); assert_eq!(right.into_inner(), 123);
Trait Implementations
impl<A, B> Stream for Either<A, B> where
A: Stream,
B: Stream<Item = <A as Stream>::Item, Error = <A as Stream>::Error>,
[src]
impl<A, B> Stream for Either<A, B> where
A: Stream,
B: Stream<Item = <A as Stream>::Item, Error = <A as Stream>::Error>,
type Item = <A as Stream>::Item
Values yielded by the stream.
type Error = <A as Stream>::Error
Errors yielded by the stream.
fn poll_next(
&mut self,
cx: &mut Context
) -> Result<Async<Option<<A as Stream>::Item>>, <A as Stream>::Error>
[src]
fn poll_next(
&mut self,
cx: &mut Context
) -> Result<Async<Option<<A as Stream>::Item>>, <A as Stream>::Error>
Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None
if the stream is exhausted. Read more
impl<A, B> Future for Either<A, B> where
A: Future,
B: Future<Item = <A as Future>::Item, Error = <A as Future>::Error>,
[src]
impl<A, B> Future for Either<A, B> where
A: Future,
B: Future<Item = <A as Future>::Item, Error = <A as Future>::Error>,
type Item = <A as Future>::Item
A successful value
type Error = <A as Future>::Error
An error
fn poll(
&mut self,
cx: &mut Context
) -> Result<Async<<A as Future>::Item>, <A as Future>::Error>
[src]
fn poll(
&mut self,
cx: &mut Context
) -> Result<Async<<A as Future>::Item>, <A as Future>::Error>
Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available. Read more
impl<L, R> Into<Result<R, L>> for Either<L, R>
[src]
impl<L, R> Into<Result<R, L>> for Either<L, R>
Convert from Either
to Result
with Right => Ok
and Left => Err
.
impl<L, R> PartialOrd<Either<L, R>> for Either<L, R> where
L: PartialOrd<L>,
R: PartialOrd<R>,
[src]
impl<L, R> PartialOrd<Either<L, R>> for Either<L, R> where
L: PartialOrd<L>,
R: PartialOrd<R>,
fn partial_cmp(&self, other: &Either<L, R>) -> Option<Ordering>
[src]
fn partial_cmp(&self, other: &Either<L, R>) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
fn lt(&self, other: &Either<L, R>) -> bool
[src]
fn lt(&self, other: &Either<L, R>) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
fn le(&self, other: &Either<L, R>) -> bool
[src]
fn le(&self, other: &Either<L, R>) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
fn gt(&self, other: &Either<L, R>) -> bool
[src]
fn gt(&self, other: &Either<L, R>) -> bool
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
fn ge(&self, other: &Either<L, R>) -> bool
[src]
fn ge(&self, other: &Either<L, R>) -> bool
This method tests greater than or equal to (for self
and other
) and is used by the >=
operator. Read more
impl<L, R, A> Extend<A> for Either<L, R> where
L: Extend<A>,
R: Extend<A>,
[src]
impl<L, R, A> Extend<A> for Either<L, R> where
L: Extend<A>,
R: Extend<A>,
fn extend<T>(&mut self, iter: T) where
T: IntoIterator<Item = A>,
[src]
fn extend<T>(&mut self, iter: T) where
T: IntoIterator<Item = A>,
Extends a collection with the contents of an iterator. Read more
impl<L, R> Hash for Either<L, R> where
L: Hash,
R: Hash,
[src]
impl<L, R> Hash for Either<L, R> where
L: Hash,
R: Hash,
fn hash<__HLR>(&self, state: &mut __HLR) where
__HLR: Hasher,
[src]
fn hash<__HLR>(&self, state: &mut __HLR) where
__HLR: Hasher,
Feeds this value into the given [Hasher
]. Read more
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
Feeds a slice of this type into the given [Hasher
]. Read more
impl<L, R> Error for Either<L, R> where
L: Error,
R: Error,
[src]
impl<L, R> Error for Either<L, R> where
L: Error,
R: Error,
Either
implements Error
if both L
and R
implement it.
fn description(&self) -> &str
[src]
fn description(&self) -> &str
This method is soft-deprecated. Read more
fn cause(&self) -> Option<&Error>
[src]
fn cause(&self) -> Option<&Error>
The lower-level cause of this error, if any. Read more
impl<L, R> Display for Either<L, R> where
L: Display,
R: Display,
[src]
impl<L, R> Display for Either<L, R> where
L: Display,
R: Display,
fn fmt(&self, f: &mut Formatter) -> Result<(), Error>
[src]
fn fmt(&self, f: &mut Formatter) -> Result<(), Error>
Formats the value using the given formatter. Read more
impl<L, R> Read for Either<L, R> where
L: Read,
R: Read,
[src]
impl<L, R> Read for Either<L, R> where
L: Read,
R: Read,
Either<L, R>
implements Read
if both L
and R
do.
Requires crate feature "use_std"
fn read(&mut self, buf: &mut [u8]) -> Result<usize, Error>
[src]
fn read(&mut self, buf: &mut [u8]) -> Result<usize, Error>
Pull some bytes from this source into the specified buffer, returning how many bytes were read. Read more
fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>
[src]
fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>
Read all bytes until EOF in this source, placing them into buf
. Read more
unsafe fn initializer(&self) -> Initializer
[src]
unsafe fn initializer(&self) -> Initializer
read_initializer
)Determines if this Read
er can work with buffers of uninitialized memory. Read more
fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
1.0.0[src]
fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
Read all bytes until EOF in this source, appending them to buf
. Read more
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
1.6.0[src]
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
Read the exact number of bytes required to fill buf
. Read more
ⓘImportant traits for &'a mut Ifn by_ref(&mut self) -> &mut Self
1.0.0[src]
fn by_ref(&mut self) -> &mut Self
Creates a "by reference" adaptor for this instance of Read
. Read more
ⓘImportant traits for Bytes<R>fn bytes(self) -> Bytes<Self>
1.0.0[src]
fn bytes(self) -> Bytes<Self>
Transforms this Read
instance to an [Iterator
] over its bytes. Read more
ⓘImportant traits for Chars<R>fn chars(self) -> Chars<Self>
[src]
fn chars(self) -> Chars<Self>
: Use str::from_utf8 instead: https://doc.rust-lang.org/nightly/std/str/struct.Utf8Error.html#examples
🔬 This is a nightly-only experimental API. (io
)
the semantics of a partial read/write of where errors happen is currently unclear and may change
Transforms this Read
instance to an [Iterator
] over [char
]s. Read more
ⓘImportant traits for Chain<T, U>fn chain<R>(self, next: R) -> Chain<Self, R> where
R: Read,
1.0.0[src]
fn chain<R>(self, next: R) -> Chain<Self, R> where
R: Read,
Creates an adaptor which will chain this stream with another. Read more
ⓘImportant traits for Take<T>fn take(self, limit: u64) -> Take<Self>
1.0.0[src]
fn take(self, limit: u64) -> Take<Self>
Creates an adaptor which will read at most limit
bytes from it. Read more
impl<L, R> DerefMut for Either<L, R> where
L: DerefMut,
R: DerefMut<Target = <L as Deref>::Target>,
[src]
impl<L, R> DerefMut for Either<L, R> where
L: DerefMut,
R: DerefMut<Target = <L as Deref>::Target>,
ⓘImportant traits for Either<L, R>fn deref_mut(&mut self) -> &mut <Either<L, R> as Deref>::Target
[src]
fn deref_mut(&mut self) -> &mut <Either<L, R> as Deref>::Target
Mutably dereferences the value.
impl<L, R> Clone for Either<L, R> where
L: Clone,
R: Clone,
[src]
impl<L, R> Clone for Either<L, R> where
L: Clone,
R: Clone,
ⓘImportant traits for Either<L, R>fn clone(&self) -> Either<L, R>
[src]
fn clone(&self) -> Either<L, R>
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
impl<L, R> Write for Either<L, R> where
L: Write,
R: Write,
[src]
impl<L, R> Write for Either<L, R> where
L: Write,
R: Write,
Either<L, R>
implements Write
if both L
and R
do.
Requires crate feature "use_std"
fn write(&mut self, buf: &[u8]) -> Result<usize, Error>
[src]
fn write(&mut self, buf: &[u8]) -> Result<usize, Error>
Write a buffer into this object, returning how many bytes were written. Read more
fn flush(&mut self) -> Result<(), Error>
[src]
fn flush(&mut self) -> Result<(), Error>
Flush this output stream, ensuring that all intermediately buffered contents reach their destination. Read more
fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
1.0.0[src]
fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
Attempts to write an entire buffer into this write. Read more
fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>
1.0.0[src]
fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>
Writes a formatted string into this writer, returning any error encountered. Read more
ⓘImportant traits for &'a mut Ifn by_ref(&mut self) -> &mut Self
1.0.0[src]
fn by_ref(&mut self) -> &mut Self
Creates a "by reference" adaptor for this instance of Write
. Read more
impl<L, R> DoubleEndedIterator for Either<L, R> where
L: DoubleEndedIterator,
R: DoubleEndedIterator<Item = <L as Iterator>::Item>,
[src]
impl<L, R> DoubleEndedIterator for Either<L, R> where
L: DoubleEndedIterator,
R: DoubleEndedIterator<Item = <L as Iterator>::Item>,
fn next_back(&mut self) -> Option<<Either<L, R> as Iterator>::Item>
[src]
fn next_back(&mut self) -> Option<<Either<L, R> as Iterator>::Item>
Removes and returns an element from the end of the iterator. Read more
fn try_rfold<B, F, R>(&mut self, init: B, f: F) -> R where
F: FnMut(B, Self::Item) -> R,
R: Try<Ok = B>,
1.27.0[src]
fn try_rfold<B, F, R>(&mut self, init: B, f: F) -> R where
F: FnMut(B, Self::Item) -> R,
R: Try<Ok = B>,
This is the reverse version of [try_fold()
]: it takes elements starting from the back of the iterator. Read more
fn rfold<B, F>(self, accum: B, f: F) -> B where
F: FnMut(B, Self::Item) -> B,
1.27.0[src]
fn rfold<B, F>(self, accum: B, f: F) -> B where
F: FnMut(B, Self::Item) -> B,
An iterator method that reduces the iterator's elements to a single, final value, starting from the back. Read more
fn rfind<P>(&mut self, predicate: P) -> Option<Self::Item> where
P: FnMut(&Self::Item) -> bool,
1.27.0[src]
fn rfind<P>(&mut self, predicate: P) -> Option<Self::Item> where
P: FnMut(&Self::Item) -> bool,
Searches for an element of an iterator from the back that satisfies a predicate. Read more
impl<L, R> Debug for Either<L, R> where
L: Debug,
R: Debug,
[src]
impl<L, R> Debug for Either<L, R> where
L: Debug,
R: Debug,
fn fmt(&self, f: &mut Formatter) -> Result<(), Error>
[src]
fn fmt(&self, f: &mut Formatter) -> Result<(), Error>
Formats the value using the given formatter. Read more
impl<L, R> Deref for Either<L, R> where
L: Deref,
R: Deref<Target = <L as Deref>::Target>,
[src]
impl<L, R> Deref for Either<L, R> where
L: Deref,
R: Deref<Target = <L as Deref>::Target>,
type Target = <L as Deref>::Target
The resulting type after dereferencing.
ⓘImportant traits for Either<L, R>fn deref(&self) -> &<Either<L, R> as Deref>::Target
[src]
fn deref(&self) -> &<Either<L, R> as Deref>::Target
Dereferences the value.
impl<L, R, Target> AsMut<Target> for Either<L, R> where
L: AsMut<Target>,
R: AsMut<Target>,
[src]
impl<L, R, Target> AsMut<Target> for Either<L, R> where
L: AsMut<Target>,
R: AsMut<Target>,
impl<L, R> BufRead for Either<L, R> where
L: BufRead,
R: BufRead,
[src]
impl<L, R> BufRead for Either<L, R> where
L: BufRead,
R: BufRead,
Requires crate feature "use_std"
fn fill_buf(&mut self) -> Result<&[u8], Error>
[src]
fn fill_buf(&mut self) -> Result<&[u8], Error>
Fills the internal buffer of this object, returning the buffer contents. Read more
fn consume(&mut self, amt: usize)
[src]
fn consume(&mut self, amt: usize)
Tells this buffer that amt
bytes have been consumed from the buffer, so they should no longer be returned in calls to read
. Read more
fn read_until(&mut self, byte: u8, buf: &mut Vec<u8>) -> Result<usize, Error>
1.0.0[src]
fn read_until(&mut self, byte: u8, buf: &mut Vec<u8>) -> Result<usize, Error>
Read all bytes into buf
until the delimiter byte
or EOF is reached. Read more
fn read_line(&mut self, buf: &mut String) -> Result<usize, Error>
1.0.0[src]
fn read_line(&mut self, buf: &mut String) -> Result<usize, Error>
Read all bytes until a newline (the 0xA byte) is reached, and append them to the provided buffer. Read more
ⓘImportant traits for Split<B>fn split(self, byte: u8) -> Split<Self>
1.0.0[src]
fn split(self, byte: u8) -> Split<Self>
Returns an iterator over the contents of this reader split on the byte byte
. Read more
ⓘImportant traits for Lines<B>fn lines(self) -> Lines<Self>
1.0.0[src]
fn lines(self) -> Lines<Self>
Returns an iterator over the lines of this reader. Read more
impl<L, R> Copy for Either<L, R> where
L: Copy,
R: Copy,
[src]
impl<L, R> Copy for Either<L, R> where
L: Copy,
R: Copy,
impl<L, R> Ord for Either<L, R> where
L: Ord,
R: Ord,
[src]
impl<L, R> Ord for Either<L, R> where
L: Ord,
R: Ord,
fn cmp(&self, other: &Either<L, R>) -> Ordering
[src]
fn cmp(&self, other: &Either<L, R>) -> Ordering
This method returns an Ordering
between self
and other
. Read more
fn max(self, other: Self) -> Self
1.21.0[src]
fn max(self, other: Self) -> Self
Compares and returns the maximum of two values. Read more
fn min(self, other: Self) -> Self
1.21.0[src]
fn min(self, other: Self) -> Self
Compares and returns the minimum of two values. Read more
impl<L, R> Eq for Either<L, R> where
L: Eq,
R: Eq,
[src]
impl<L, R> Eq for Either<L, R> where
L: Eq,
R: Eq,
impl<L, R, Target> AsRef<Target> for Either<L, R> where
L: AsRef<Target>,
R: AsRef<Target>,
[src]
impl<L, R, Target> AsRef<Target> for Either<L, R> where
L: AsRef<Target>,
R: AsRef<Target>,
impl<L, R> Iterator for Either<L, R> where
L: Iterator,
R: Iterator<Item = <L as Iterator>::Item>,
[src]
impl<L, R> Iterator for Either<L, R> where
L: Iterator,
R: Iterator<Item = <L as Iterator>::Item>,
Either<L, R>
is an iterator if both L
and R
are iterators.
type Item = <L as Iterator>::Item
The type of the elements being iterated over.
fn next(&mut self) -> Option<<Either<L, R> as Iterator>::Item>
[src]
fn next(&mut self) -> Option<<Either<L, R> as Iterator>::Item>
Advances the iterator and returns the next value. Read more
fn size_hint(&self) -> (usize, Option<usize>)
[src]
fn size_hint(&self) -> (usize, Option<usize>)
Returns the bounds on the remaining length of the iterator. Read more
fn fold<Acc, G>(self, init: Acc, f: G) -> Acc where
G: FnMut(Acc, <Either<L, R> as Iterator>::Item) -> Acc,
[src]
fn fold<Acc, G>(self, init: Acc, f: G) -> Acc where
G: FnMut(Acc, <Either<L, R> as Iterator>::Item) -> Acc,
An iterator method that applies a function, producing a single, final value. Read more
fn count(self) -> usize
[src]
fn count(self) -> usize
Consumes the iterator, counting the number of iterations and returning it. Read more
fn last(self) -> Option<<Either<L, R> as Iterator>::Item>
[src]
fn last(self) -> Option<<Either<L, R> as Iterator>::Item>
Consumes the iterator, returning the last element. Read more
fn nth(&mut self, n: usize) -> Option<<Either<L, R> as Iterator>::Item>
[src]
fn nth(&mut self, n: usize) -> Option<<Either<L, R> as Iterator>::Item>
Returns the n
th element of the iterator. Read more
fn collect<B>(self) -> B where
B: FromIterator<<Either<L, R> as Iterator>::Item>,
[src]
fn collect<B>(self) -> B where
B: FromIterator<<Either<L, R> as Iterator>::Item>,
Transforms an iterator into a collection. Read more
fn all<F>(&mut self, f: F) -> bool where
F: FnMut(<Either<L, R> as Iterator>::Item) -> bool,
[src]
fn all<F>(&mut self, f: F) -> bool where
F: FnMut(<Either<L, R> as Iterator>::Item) -> bool,
Tests if every element of the iterator matches a predicate. Read more
ⓘImportant traits for StepBy<I>fn step_by(self, step: usize) -> StepBy<Self>
[src]
fn step_by(self, step: usize) -> StepBy<Self>
🔬 This is a nightly-only experimental API. (iterator_step_by
)
unstable replacement of Range::step_by
Creates an iterator starting at the same point, but stepping by the given amount at each iteration. Read more
ⓘImportant traits for Chain<A, B>fn chain<U>(self, other: U) -> Chain<Self, <U as IntoIterator>::IntoIter> where
U: IntoIterator<Item = Self::Item>,
1.0.0[src]
fn chain<U>(self, other: U) -> Chain<Self, <U as IntoIterator>::IntoIter> where
U: IntoIterator<Item = Self::Item>,
Takes two iterators and creates a new iterator over both in sequence. Read more
ⓘImportant traits for Zip<A, B>fn zip<U>(self, other: U) -> Zip<Self, <U as IntoIterator>::IntoIter> where
U: IntoIterator,
1.0.0[src]
fn zip<U>(self, other: U) -> Zip<Self, <U as IntoIterator>::IntoIter> where
U: IntoIterator,
'Zips up' two iterators into a single iterator of pairs. Read more
ⓘImportant traits for Map<I, F>fn map<B, F>(self, f: F) -> Map<Self, F> where
F: FnMut(Self::Item) -> B,
1.0.0[src]
fn map<B, F>(self, f: F) -> Map<Self, F> where
F: FnMut(Self::Item) -> B,
Takes a closure and creates an iterator which calls that closure on each element. Read more
fn for_each<F>(self, f: F) where
F: FnMut(Self::Item),
1.21.0[src]
fn for_each<F>(self, f: F) where
F: FnMut(Self::Item),
Calls a closure on each element of an iterator. Read more
ⓘImportant traits for Filter<I, P>fn filter<P>(self, predicate: P) -> Filter<Self, P> where
P: FnMut(&Self::Item) -> bool,
1.0.0[src]
fn filter<P>(self, predicate: P) -> Filter<Self, P> where
P: FnMut(&Self::Item) -> bool,
Creates an iterator which uses a closure to determine if an element should be yielded. Read more
ⓘImportant traits for FilterMap<I, F>fn filter_map<B, F>(self, f: F) -> FilterMap<Self, F> where
F: FnMut(Self::Item) -> Option<B>,
1.0.0[src]
fn filter_map<B, F>(self, f: F) -> FilterMap<Self, F> where
F: FnMut(Self::Item) -> Option<B>,
Creates an iterator that both filters and maps. Read more
ⓘImportant traits for Enumerate<I>fn enumerate(self) -> Enumerate<Self>
1.0.0[src]
fn enumerate(self) -> Enumerate<Self>
Creates an iterator which gives the current iteration count as well as the next value. Read more
ⓘImportant traits for Peekable<I>fn peekable(self) -> Peekable<Self>
1.0.0[src]
fn peekable(self) -> Peekable<Self>
Creates an iterator which can use peek
to look at the next element of the iterator without consuming it. Read more
ⓘImportant traits for SkipWhile<I, P>fn skip_while<P>(self, predicate: P) -> SkipWhile<Self, P> where
P: FnMut(&Self::Item) -> bool,
1.0.0[src]
fn skip_while<P>(self, predicate: P) -> SkipWhile<Self, P> where
P: FnMut(&Self::Item) -> bool,
Creates an iterator that [skip
]s elements based on a predicate. Read more
ⓘImportant traits for TakeWhile<I, P>fn take_while<P>(self, predicate: P) -> TakeWhile<Self, P> where
P: FnMut(&Self::Item) -> bool,
1.0.0[src]
fn take_while<P>(self, predicate: P) -> TakeWhile<Self, P> where
P: FnMut(&Self::Item) -> bool,
Creates an iterator that yields elements based on a predicate. Read more
ⓘImportant traits for Skip<I>fn skip(self, n: usize) -> Skip<Self>
1.0.0[src]
fn skip(self, n: usize) -> Skip<Self>
Creates an iterator that skips the first n
elements. Read more
ⓘImportant traits for Take<I>fn take(self, n: usize) -> Take<Self>
1.0.0[src]
fn take(self, n: usize) -> Take<Self>
Creates an iterator that yields its first n
elements. Read more
ⓘImportant traits for Scan<I, St, F>fn scan<St, B, F>(self, initial_state: St, f: F) -> Scan<Self, St, F> where
F: FnMut(&mut St, Self::Item) -> Option<B>,
1.0.0[src]
fn scan<St, B, F>(self, initial_state: St, f: F) -> Scan<Self, St, F> where
F: FnMut(&mut St, Self::Item) -> Option<B>,
An iterator adaptor similar to [fold
] that holds internal state and produces a new iterator. Read more
ⓘImportant traits for FlatMap<I, U, F>fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F> where
F: FnMut(Self::Item) -> U,
U: IntoIterator,
1.0.0[src]
fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F> where
F: FnMut(Self::Item) -> U,
U: IntoIterator,
Creates an iterator that works like map, but flattens nested structure. Read more
ⓘImportant traits for Flatten<I>fn flatten(self) -> Flatten<Self> where
Self::Item: IntoIterator,
[src]
fn flatten(self) -> Flatten<Self> where
Self::Item: IntoIterator,
iterator_flatten
)Creates an iterator that flattens nested structure. Read more
ⓘImportant traits for Fuse<I>fn fuse(self) -> Fuse<Self>
1.0.0[src]
fn fuse(self) -> Fuse<Self>
Creates an iterator which ends after the first [None
]. Read more
ⓘImportant traits for Inspect<I, F>fn inspect<F>(self, f: F) -> Inspect<Self, F> where
F: FnMut(&Self::Item),
1.0.0[src]
fn inspect<F>(self, f: F) -> Inspect<Self, F> where
F: FnMut(&Self::Item),
Do something with each element of an iterator, passing the value on. Read more
ⓘImportant traits for &'a mut Ifn by_ref(&mut self) -> &mut Self
1.0.0[src]
fn by_ref(&mut self) -> &mut Self
Borrows an iterator, rather than consuming it. Read more
fn partition<B, F>(self, f: F) -> (B, B) where
B: Default + Extend<Self::Item>,
F: FnMut(&Self::Item) -> bool,
1.0.0[src]
fn partition<B, F>(self, f: F) -> (B, B) where
B: Default + Extend<Self::Item>,
F: FnMut(&Self::Item) -> bool,
Consumes an iterator, creating two collections from it. Read more
fn try_fold<B, F, R>(&mut self, init: B, f: F) -> R where
F: FnMut(B, Self::Item) -> R,
R: Try<Ok = B>,
1.27.0[src]
fn try_fold<B, F, R>(&mut self, init: B, f: F) -> R where
F: FnMut(B, Self::Item) -> R,
R: Try<Ok = B>,
An iterator method that applies a function as long as it returns successfully, producing a single, final value. Read more
fn try_for_each<F, R>(&mut self, f: F) -> R where
F: FnMut(Self::Item) -> R,
R: Try<Ok = ()>,
1.27.0[src]
fn try_for_each<F, R>(&mut self, f: F) -> R where
F: FnMut(Self::Item) -> R,
R: Try<Ok = ()>,
An iterator method that applies a fallible function to each item in the iterator, stopping at the first error and returning that error. Read more
fn any<F>(&mut self, f: F) -> bool where
F: FnMut(Self::Item) -> bool,
1.0.0[src]
fn any<F>(&mut self, f: F) -> bool where
F: FnMut(Self::Item) -> bool,
Tests if any element of the iterator matches a predicate. Read more
fn find<P>(&mut self, predicate: P) -> Option<Self::Item> where
P: FnMut(&Self::Item) -> bool,
1.0.0[src]
fn find<P>(&mut self, predicate: P) -> Option<Self::Item> where
P: FnMut(&Self::Item) -> bool,
Searches for an element of an iterator that satisfies a predicate. Read more
fn find_map<B, F>(&mut self, f: F) -> Option<B> where
F: FnMut(Self::Item) -> Option<B>,
[src]
fn find_map<B, F>(&mut self, f: F) -> Option<B> where
F: FnMut(Self::Item) -> Option<B>,
🔬 This is a nightly-only experimental API. (iterator_find_map
)
unstable new API
Applies function to the elements of iterator and returns the first non-none result. Read more
fn position<P>(&mut self, predicate: P) -> Option<usize> where
P: FnMut(Self::Item) -> bool,
1.0.0[src]
fn position<P>(&mut self, predicate: P) -> Option<usize> where
P: FnMut(Self::Item) -> bool,
Searches for an element in an iterator, returning its index. Read more
fn rposition<P>(&mut self, predicate: P) -> Option<usize> where
P: FnMut(Self::Item) -> bool,
Self: ExactSizeIterator + DoubleEndedIterator,
1.0.0[src]
fn rposition<P>(&mut self, predicate: P) -> Option<usize> where
P: FnMut(Self::Item) -> bool,
Self: ExactSizeIterator + DoubleEndedIterator,
Searches for an element in an iterator from the right, returning its index. Read more
fn max(self) -> Option<Self::Item> where
Self::Item: Ord,
1.0.0[src]
fn max(self) -> Option<Self::Item> where
Self::Item: Ord,
Returns the maximum element of an iterator. Read more
fn min(self) -> Option<Self::Item> where
Self::Item: Ord,
1.0.0[src]
fn min(self) -> Option<Self::Item> where
Self::Item: Ord,
Returns the minimum element of an iterator. Read more
fn max_by_key<B, F>(self, f: F) -> Option<Self::Item> where
B: Ord,
F: FnMut(&Self::Item) -> B,
1.6.0[src]
fn max_by_key<B, F>(self, f: F) -> Option<Self::Item> where
B: Ord,
F: FnMut(&Self::Item) -> B,
Returns the element that gives the maximum value from the specified function. Read more
fn max_by<F>(self, compare: F) -> Option<Self::Item> where
F: FnMut(&Self::Item, &Self::Item) -> Ordering,
1.15.0[src]
fn max_by<F>(self, compare: F) -> Option<Self::Item> where
F: FnMut(&Self::Item, &Self::Item) -> Ordering,
Returns the element that gives the maximum value with respect to the specified comparison function. Read more
fn min_by_key<B, F>(self, f: F) -> Option<Self::Item> where
B: Ord,
F: FnMut(&Self::Item) -> B,
1.6.0[src]
fn min_by_key<B, F>(self, f: F) -> Option<Self::Item> where
B: Ord,
F: FnMut(&Self::Item) -> B,
Returns the element that gives the minimum value from the specified function. Read more
fn min_by<F>(self, compare: F) -> Option<Self::Item> where
F: FnMut(&Self::Item, &Self::Item) -> Ordering,
1.15.0[src]
fn min_by<F>(self, compare: F) -> Option<Self::Item> where
F: FnMut(&Self::Item, &Self::Item) -> Ordering,
Returns the element that gives the minimum value with respect to the specified comparison function. Read more
ⓘImportant traits for Rev<I>fn rev(self) -> Rev<Self> where
Self: DoubleEndedIterator,
1.0.0[src]
fn rev(self) -> Rev<Self> where
Self: DoubleEndedIterator,
Reverses an iterator's direction. Read more
fn unzip<A, B, FromA, FromB>(self) -> (FromA, FromB) where
FromA: Default + Extend<A>,
FromB: Default + Extend<B>,
Self: Iterator<Item = (A, B)>,
1.0.0[src]
fn unzip<A, B, FromA, FromB>(self) -> (FromA, FromB) where
FromA: Default + Extend<A>,
FromB: Default + Extend<B>,
Self: Iterator<Item = (A, B)>,
Converts an iterator of pairs into a pair of containers. Read more
ⓘImportant traits for Cloned<I>fn cloned<'a, T>(self) -> Cloned<Self> where
Self: Iterator<Item = &'a T>,
T: 'a + Clone,
1.0.0[src]
fn cloned<'a, T>(self) -> Cloned<Self> where
Self: Iterator<Item = &'a T>,
T: 'a + Clone,
Creates an iterator which [clone
]s all of its elements. Read more
ⓘImportant traits for Cycle<I>fn cycle(self) -> Cycle<Self> where
Self: Clone,
1.0.0[src]
fn cycle(self) -> Cycle<Self> where
Self: Clone,
Repeats an iterator endlessly. Read more
fn sum<S>(self) -> S where
S: Sum<Self::Item>,
1.11.0[src]
fn sum<S>(self) -> S where
S: Sum<Self::Item>,
Sums the elements of an iterator. Read more
fn product<P>(self) -> P where
P: Product<Self::Item>,
1.11.0[src]
fn product<P>(self) -> P where
P: Product<Self::Item>,
Iterates over the entire iterator, multiplying all the elements Read more
fn cmp<I>(self, other: I) -> Ordering where
I: IntoIterator<Item = Self::Item>,
Self::Item: Ord,
1.5.0[src]
fn cmp<I>(self, other: I) -> Ordering where
I: IntoIterator<Item = Self::Item>,
Self::Item: Ord,
Lexicographically compares the elements of this Iterator
with those of another. Read more
fn partial_cmp<I>(self, other: I) -> Option<Ordering> where
I: IntoIterator,
Self::Item: PartialOrd<<I as IntoIterator>::Item>,
1.5.0[src]
fn partial_cmp<I>(self, other: I) -> Option<Ordering> where
I: IntoIterator,
Self::Item: PartialOrd<<I as IntoIterator>::Item>,
Lexicographically compares the elements of this Iterator
with those of another. Read more
fn eq<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialEq<<I as IntoIterator>::Item>,
1.5.0[src]
fn eq<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialEq<<I as IntoIterator>::Item>,
Determines if the elements of this Iterator
are equal to those of another. Read more
fn ne<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialEq<<I as IntoIterator>::Item>,
1.5.0[src]
fn ne<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialEq<<I as IntoIterator>::Item>,
Determines if the elements of this Iterator
are unequal to those of another. Read more
fn lt<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialOrd<<I as IntoIterator>::Item>,
1.5.0[src]
fn lt<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialOrd<<I as IntoIterator>::Item>,
Determines if the elements of this Iterator
are lexicographically less than those of another. Read more
fn le<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialOrd<<I as IntoIterator>::Item>,
1.5.0[src]
fn le<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialOrd<<I as IntoIterator>::Item>,
Determines if the elements of this Iterator
are lexicographically less or equal to those of another. Read more
fn gt<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialOrd<<I as IntoIterator>::Item>,
1.5.0[src]
fn gt<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialOrd<<I as IntoIterator>::Item>,
Determines if the elements of this Iterator
are lexicographically greater than those of another. Read more
fn ge<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialOrd<<I as IntoIterator>::Item>,
1.5.0[src]
fn ge<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialOrd<<I as IntoIterator>::Item>,
Determines if the elements of this Iterator
are lexicographically greater than or equal to those of another. Read more
impl<L, R> PartialEq<Either<L, R>> for Either<L, R> where
L: PartialEq<L>,
R: PartialEq<R>,
[src]
impl<L, R> PartialEq<Either<L, R>> for Either<L, R> where
L: PartialEq<L>,
R: PartialEq<R>,
fn eq(&self, other: &Either<L, R>) -> bool
[src]
fn eq(&self, other: &Either<L, R>) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Either<L, R>) -> bool
[src]
fn ne(&self, other: &Either<L, R>) -> bool
This method tests for !=
.
impl<L, R> From<Result<R, L>> for Either<L, R>
[src]
impl<L, R> From<Result<R, L>> for Either<L, R>
Convert from Result
to Either
with Ok => Right
and Err => Left
.
ⓘImportant traits for Either<L, R>fn from(r: Result<R, L>) -> Either<L, R>
[src]
fn from(r: Result<R, L>) -> Either<L, R>
Performs the conversion.
impl<L, R> ExactSizeIterator for Either<L, R> where
L: ExactSizeIterator,
R: ExactSizeIterator<Item = <L as Iterator>::Item>,
[src]
impl<L, R> ExactSizeIterator for Either<L, R> where
L: ExactSizeIterator,
R: ExactSizeIterator<Item = <L as Iterator>::Item>,
fn len(&self) -> usize
1.0.0[src]
fn len(&self) -> usize
Returns the exact number of times the iterator will iterate. Read more
fn is_empty(&self) -> bool
[src]
fn is_empty(&self) -> bool
exact_size_is_empty
)Returns whether the iterator is empty. Read more
impl<A, B> Sink for Either<A, B> where
A: Sink,
B: Sink<SinkItem = <A as Sink>::SinkItem, SinkError = <A as Sink>::SinkError>,
[src]
impl<A, B> Sink for Either<A, B> where
A: Sink,
B: Sink<SinkItem = <A as Sink>::SinkItem, SinkError = <A as Sink>::SinkError>,
type SinkItem = <A as Sink>::SinkItem
The type of value that the sink accepts.
type SinkError = <A as Sink>::SinkError
The type of value produced by the sink when an error occurs.
fn poll_ready(
&mut self,
cx: &mut Context
) -> Result<Async<()>, <Either<A, B> as Sink>::SinkError>
[src]
fn poll_ready(
&mut self,
cx: &mut Context
) -> Result<Async<()>, <Either<A, B> as Sink>::SinkError>
Attempts to prepare the Sink
to receive a value. Read more
fn start_send(
&mut self,
item: <Either<A, B> as Sink>::SinkItem
) -> Result<(), <Either<A, B> as Sink>::SinkError>
[src]
fn start_send(
&mut self,
item: <Either<A, B> as Sink>::SinkItem
) -> Result<(), <Either<A, B> as Sink>::SinkError>
Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready
which returned Ok(Async::Ready(()))
. Read more
fn poll_flush(
&mut self,
cx: &mut Context
) -> Result<Async<()>, <Either<A, B> as Sink>::SinkError>
[src]
fn poll_flush(
&mut self,
cx: &mut Context
) -> Result<Async<()>, <Either<A, B> as Sink>::SinkError>
Flush any remaining output from this sink. Read more
fn poll_close(
&mut self,
cx: &mut Context
) -> Result<Async<()>, <Either<A, B> as Sink>::SinkError>
[src]
fn poll_close(
&mut self,
cx: &mut Context
) -> Result<Async<()>, <Either<A, B> as Sink>::SinkError>
Flush any remaining output and close this sink, if necessary. Read more