[][src]Struct starb::RingBuffer

pub struct RingBuffer<T> { /* fields omitted */ }

A lock-free concurrent ring buffer that prevents overwriting data before it is read.

Methods

impl<T> RingBuffer<T> where
    T: Copy
[src]

pub const fn new(default: T) -> Self[src]

Create a new RingBuffer.

The default element isn't important, but is, unfortunately, currently required to make stable rust happy.

pub const fn split<'a>(&'a self) -> (Reader<T>, Writer<T>)[src]

Splits the ring buffer into a consumer/producer pair (Reader/Writer respectively). These structures can be used safely across threads.

Auto Trait Implementations

impl<T> Unpin for RingBuffer<T> where
    T: Unpin

impl<T> !Sync for RingBuffer<T>

impl<T> Send for RingBuffer<T> where
    T: Send

Blanket Implementations

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> From<T> for T[src]

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]