[go: up one dir, main page]

Struct scc::Stack

source ·
pub struct Stack<T> { /* private fields */ }
Expand description

Stack is a lock-free concurrent last-in-first-out container.

Implementations§

source§

impl<T: 'static> Stack<T>

source

pub fn push(&self, val: T) -> Arc<Entry<T>>

Pushes an instance of T.

Returns an Arc holding a strong reference to the newly pushed entry.

Examples
use scc::Stack;

let stack: Stack<usize> = Stack::default();

assert_eq!(**stack.push(11), 11);
source

pub fn push_if<F: FnMut(Option<&Entry<T>>) -> bool>( &self, val: T, cond: F ) -> Result<Arc<Entry<T>>, T>

Pushes an instance of T if the newest entry satisfies the given condition.

Errors

Returns an error along with the supplied instance if the condition is not met.

Examples
use scc::Stack;

let stack: Stack<usize> = Stack::default();

stack.push(11);

assert!(stack.push_if(17, |e| e.map_or(false, |x| **x == 11)).is_ok());
assert!(stack.push_if(29, |e| e.map_or(false, |x| **x == 11)).is_err());
source

pub fn peek_with<'b, R, F: FnOnce(Option<&'b Entry<T>>) -> R>( &self, reader: F, barrier: &'b Barrier ) -> R

Peeks the newest entry with the supplied Barrier.

Examples
use scc::ebr::Barrier;
use scc::Stack;

let stack: Stack<usize> = Stack::default();

assert!(stack.peek_with(|v| v.is_none(), &Barrier::new()));

stack.push(37);
stack.push(3);

assert_eq!(stack.peek_with(|v| **v.unwrap(), &Barrier::new()), 3);
source§

impl<T> Stack<T>

source

pub unsafe fn push_unchecked(&self, val: T) -> Arc<Entry<T>>

Pushes an instance of T without checking the lifetime of T.

Returns an Arc holding a strong reference to the newly pushed entry.

Safety

T::drop can be run after the Stack is dropped, therefore it is safe only if T::drop does not access short-lived data or std::mem::needs_drop is false for T,

Examples
use scc::Stack;

let hello = String::from("hello");
let stack: Stack<&str> = Stack::default();

assert_eq!(unsafe { **stack.push_unchecked(hello.as_str()) }, "hello");
source

pub unsafe fn push_if_unchecked<F: FnMut(Option<&Entry<T>>) -> bool>( &self, val: T, cond: F ) -> Result<Arc<Entry<T>>, T>

Pushes an instance of T if the newest entry satisfies the given condition without checking the lifetime of T.

Errors

Returns an error along with the supplied instance if the condition is not met.

Safety

T::drop can be run after the Stack is dropped, therefore it is safe only if T::drop does not access short-lived data or std::mem::needs_drop is false for T,

Examples
use scc::Stack;

let hello = String::from("hello");
let stack: Stack<&str> = Stack::default();

assert!(unsafe { stack.push_if_unchecked(hello.as_str(), |e| e.is_none()).is_ok() });
source

pub fn pop(&self) -> Option<Arc<Entry<T>>>

Pops the newest entry.

Returns None if the Stack is empty.

Examples
use scc::Stack;

let stack: Stack<usize> = Stack::default();

stack.push(37);
stack.push(3);
stack.push(1);

assert_eq!(stack.pop().map(|e| **e), Some(1));
assert_eq!(stack.pop().map(|e| **e), Some(3));
assert_eq!(stack.pop().map(|e| **e), Some(37));
assert!(stack.pop().is_none());
source

pub fn pop_if<F: FnMut(&Entry<T>) -> bool>( &self, cond: F ) -> Result<Option<Arc<Entry<T>>>, Arc<Entry<T>>>

Pops the newest entry if the entry satisfies the given condition.

Returns None if the Stack is empty.

Errors

Returns an error along with the newest entry if the given condition is not met.

Examples
use scc::Stack;

let stack: Stack<usize> = Stack::default();

stack.push(3);
stack.push(1);

assert!(stack.pop_if(|v| **v == 3).is_err());
assert_eq!(stack.pop().map(|e| **e), Some(1));
assert_eq!(stack.pop_if(|v| **v == 3).ok().and_then(|e| e).map(|e| **e), Some(3));

assert!(stack.is_empty());
source

pub fn peek<R, F: FnOnce(Option<&Entry<T>>) -> R>(&self, reader: F) -> R

Peeks the newest entry.

Examples
use scc::Stack;

let stack: Stack<usize> = Stack::default();

assert!(stack.peek(|v| v.is_none()));

stack.push(37);
stack.push(3);

assert_eq!(stack.peek(|v| **v.unwrap()), 3);
source

pub fn is_empty(&self) -> bool

Returns true if the Stack is empty.

Examples
use scc::Stack;

let stack: Stack<usize> = Stack::default();
assert!(stack.is_empty());

stack.push(7);
assert!(!stack.is_empty());

Trait Implementations§

source§

impl<T: Clone> Clone for Stack<T>

source§

fn clone(&self) -> Self

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> Debug for Stack<T>

source§

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

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

impl<T> Default for Stack<T>

source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<T> RefUnwindSafe for Stack<T>

§

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

§

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

§

impl<T> Unpin for Stack<T>

§

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

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere 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 Twhere 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> ToOwned for Twhere 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 Twhere 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 Twhere 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.