pub enum Steal<T> {
    Empty,
    Success(T),
    Retry,
}
Expand description

Possible outcomes of a steal operation.

Examples

There are lots of ways to chain results of steal operations together:

use crossbeam_deque::Steal::{self, Empty, Retry, Success};

let collect = |v: Vec<Steal<i32>>| v.into_iter().collect::<Steal<i32>>();

assert_eq!(collect(vec![Empty, Empty, Empty]), Empty);
assert_eq!(collect(vec![Empty, Retry, Empty]), Retry);
assert_eq!(collect(vec![Retry, Success(1), Empty]), Success(1));

assert_eq!(collect(vec![Empty, Empty]).or_else(|| Retry), Retry);
assert_eq!(collect(vec![Retry, Empty]).or_else(|| Success(1)), Success(1));

Variants§

§

Empty

The queue was empty at the time of stealing.

§

Success(T)

At least one task was successfully stolen.

§

Retry

The steal operation needs to be retried.

Implementations§

source§

impl<T> Steal<T>

source

pub fn is_empty(&self) -> bool

Returns true if the queue was empty at the time of stealing.

Examples
use crossbeam_deque::Steal::{Empty, Retry, Success};

assert!(!Success(7).is_empty());
assert!(!Retry::<i32>.is_empty());

assert!(Empty::<i32>.is_empty());
source

pub fn is_success(&self) -> bool

Returns true if at least one task was stolen.

Examples
use crossbeam_deque::Steal::{Empty, Retry, Success};

assert!(!Empty::<i32>.is_success());
assert!(!Retry::<i32>.is_success());

assert!(Success(7).is_success());
source

pub fn is_retry(&self) -> bool

Returns true if the steal operation needs to be retried.

Examples
use crossbeam_deque::Steal::{Empty, Retry, Success};

assert!(!Empty::<i32>.is_retry());
assert!(!Success(7).is_retry());

assert!(Retry::<i32>.is_retry());
source

pub fn success(self) -> Option<T>

Returns the result of the operation, if successful.

Examples
use crossbeam_deque::Steal::{Empty, Retry, Success};

assert_eq!(Empty::<i32>.success(), None);
assert_eq!(Retry::<i32>.success(), None);

assert_eq!(Success(7).success(), Some(7));
source

pub fn or_else<F>(self, f: F) -> Steal<T>
where F: FnOnce() -> Steal<T>,

If no task was stolen, attempts another steal operation.

Returns this steal result if it is Success. Otherwise, closure f is invoked and then:

  • If the second steal resulted in Success, it is returned.
  • If both steals were unsuccessful but any resulted in Retry, then Retry is returned.
  • If both resulted in None, then None is returned.
Examples
use crossbeam_deque::Steal::{Empty, Retry, Success};

assert_eq!(Success(1).or_else(|| Success(2)), Success(1));
assert_eq!(Retry.or_else(|| Success(2)), Success(2));

assert_eq!(Retry.or_else(|| Empty), Retry::<i32>);
assert_eq!(Empty.or_else(|| Retry), Retry::<i32>);

assert_eq!(Empty.or_else(|| Empty), Empty::<i32>);

Trait Implementations§

source§

impl<T: Clone> Clone for Steal<T>

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<T> Debug for Steal<T>

source§

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

Formats the value using the given formatter. Read more
source§

impl<T> FromIterator<Steal<T>> for Steal<T>

source§

fn from_iter<I>(iter: I) -> Steal<T>
where I: IntoIterator<Item = Steal<T>>,

Consumes items until a Success is found and returns it.

If no Success was found, but there was at least one Retry, then returns Retry. Otherwise, Empty is returned.

source§

impl<T: PartialEq> PartialEq for Steal<T>

source§

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

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

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.
source§

impl<T: Copy> Copy for Steal<T>

source§

impl<T: Eq> Eq for Steal<T>

source§

impl<T> StructuralEq for Steal<T>

source§

impl<T> StructuralPartialEq for Steal<T>

Auto Trait Implementations§

§

impl<T> RefUnwindSafe for Steal<T>
where T: RefUnwindSafe,

§

impl<T> Send for Steal<T>
where T: Send,

§

impl<T> Sync for Steal<T>
where T: Sync,

§

impl<T> Unpin for Steal<T>
where T: Unpin,

§

impl<T> UnwindSafe for Steal<T>
where T: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Pointable for T

source§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.