Struct matrix_sdk_common::ring_buffer::RingBuffer

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

A simple fixed-size ring buffer implementation.

A size is provided on creation, and the ring buffer reserves that much space, and never reallocates.

Implementations§

source§

impl<T> RingBuffer<T>

source

pub fn new(size: NonZeroUsize) -> Self

Create a ring buffer with the supplied capacity, reserving it so we never need to reallocate.

source

pub fn len(&self) -> usize

Returns the number of items that are stored in this ring buffer.

This is the dynamic size indicating how many items are held in the buffer, not the fixed capacity.

source

pub fn is_empty(&self) -> bool

Returns true if the ring buffer contains no elements.

source

pub fn get(&self, index: usize) -> Option<&T>

Provides a reference to the element at the given index.

Element at index zero is the “front” i.e. one that will be returned if we call pop().

source

pub fn push(&mut self, value: T)

Appends an element to the back of the ring buffer

source

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

Removes the first element and returns it, or None if the ring buffer is empty.

source

pub fn remove(&mut self, index: usize) -> Option<T>

Removes and returns one specific element at index if it exists, otherwise it returns None.

source

pub fn iter(&self) -> Iter<'_, T>

Returns an iterator that provides elements in front-to-back order, i.e. the same order you would get if you repeatedly called pop().

source

pub fn iter_mut(&mut self) -> IterMut<'_, T>

Returns a mutable iterator that provides elements in front-to-back order, i.e. the same order you would get if you repeatedly called pop().

source

pub fn drain<R>(&mut self, range: R) -> Drain<'_, T>
where R: RangeBounds<usize>,

Returns an iterator that drains its items.

source

pub fn clear(&mut self)

Clears the ring buffer, removing all values. This does not affect the capacity.

source

pub fn capacity(&self) -> usize

Returns the total number of elements the RingBuffer can hold.

source

pub fn retain<F>(&mut self, predicate: F)
where F: FnMut(&T) -> bool,

Retains only the elements specified by the predicate.

Trait Implementations§

source§

impl<T: Clone> Clone for RingBuffer<T>

source§

fn clone(&self) -> RingBuffer<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> Debug for RingBuffer<T>

source§

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

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

impl<'de, T> Deserialize<'de> for RingBuffer<T>
where T: Deserialize<'de>,

source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl<U> Extend<U> for RingBuffer<U>

source§

fn extend<T: IntoIterator<Item = U>>(&mut self, iter: T)

Extends a collection with the contents of an iterator. Read more
source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
source§

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
source§

impl<T: PartialEq> PartialEq for RingBuffer<T>

source§

fn eq(&self, other: &RingBuffer<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> Serialize for RingBuffer<T>
where T: Serialize,

source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
source§

impl<T> StructuralPartialEq for RingBuffer<T>

Auto Trait Implementations§

§

impl<T> Freeze for RingBuffer<T>

§

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

§

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

§

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

§

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

§

impl<T> UnwindSafe for RingBuffer<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> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

source§

const WITNESS: W = W::MAKE

A constant of the type witness
source§

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

§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
source§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> 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.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<T> AsyncTraitDeps for T

source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

source§

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

source§

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