Struct Reader

Source
pub struct Reader<T> { /* private fields */ }
Expand description

Reader for a blocking circular buffer with items of type T.

Implementations§

Source§

impl<T> Reader<T>

Source

pub fn slice(&mut self) -> Option<&[T]>

Blocks until there is data to read or until the writer is dropped.

If all data is read and the writer is dropped, all following calls will return None. If Some is returned, the contained slice is never empty.

Source

pub fn try_slice(&mut self) -> Option<&[T]>

Checks if there is data to read.

If all data is read and the writer is dropped, all following calls will return None. If there is no data to read, Some is returned with an empty slice.

Source

pub fn consume(&mut self, n: usize)

Indicates that n items were read.

§Panics

If consumed more than space was available in the last provided slice.

Auto Trait Implementations§

§

impl<T> Freeze for Reader<T>

§

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

§

impl<T> Send for Reader<T>
where T: Sync + Send,

§

impl<T> !Sync for Reader<T>

§

impl<T> Unpin for Reader<T>

§

impl<T> UnwindSafe for Reader<T>
where T: RefUnwindSafe,

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, U> TryFrom<U> for T
where U: Into<T>,

Source§

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>,

Source§

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.