pub struct RingBuffer { /* private fields */ }
Expand description

A circular buffer implementation.

A RingBuffer holds a logically contiguous ring of memory in three regions:

  • readable: memory is available for reading and not for writing,
  • writable: memory that is available for writing and not for reading,
  • reserved: memory that was read from and is no longer available for reading or for writing.

Zero or more of these regions can be empty, and a region of memory can transition from one to another in a few different ways:

Readable memory, once read, becomes writable unless a shrink operation is in progress, in which case it becomes reserved.

Writable memory, once marked as such, becomes readable.

Reserved memory will never become readable or writable, and is non-empty only while a shrink is in progress. Once the reserved segment is large enough it will be removed to complete the shrinking.

Implementations§

source§

impl RingBuffer

source

pub fn new(capacity: usize) -> Self

Creates a new RingBuffer.

source

pub fn read_with<F>(&mut self, f: F) -> usize
where F: for<'a, 'b> FnOnce(&'b [&'a [u8]]) -> usize,

Calls f with contiguous sequences of readable bytes in the buffer and discards the amount of bytes returned by f.

§Panics

Panics if the closure wants to discard more bytes than possible, i.e., the value returned by f is greater than self.len().

source

pub fn writable_regions(&mut self) -> impl IntoIterator<Item = &mut [u8]>

Returns the writable regions of the RingBuffer.

source

pub fn set_target_size(&mut self, new_capacity: usize)

Sets the target size for the RingBuffer.

Calling this must not cause the buffer to drop any data. If the new size can be accommodated immediately, it will be applied. Otherwise the buffer will be resized opportunistically during future operatins.

Trait Implementations§

source§

impl Buffer for RingBuffer

source§

fn limits(&self) -> BufferLimits

Returns information about the number of bytes in the buffer. Read more
source§

fn target_capacity(&self) -> usize

Gets the target size of the buffer, in bytes. Read more
source§

fn request_capacity(&mut self, size: usize)

Requests that the buffer be resized to hold the given number of bytes. Read more
source§

impl Clone for RingBuffer

source§

fn clone(&self) -> RingBuffer

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 Debug for RingBuffer

source§

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

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

impl Default for RingBuffer

source§

fn default() -> Self

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

impl PartialEq for RingBuffer

source§

fn eq(&self, other: &RingBuffer) -> 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 ReceiveBuffer for RingBuffer

source§

fn write_at<P: Payload>(&mut self, offset: usize, data: &P) -> usize

Writes data into the buffer at offset. Read more
source§

fn make_readable(&mut self, count: usize)

Marks count bytes available for the application to read. Read more
source§

impl SendBuffer for RingBuffer

source§

fn mark_read(&mut self, count: usize)

Removes count bytes from the beginning of the buffer as already read. Read more
source§

fn peek_with<'a, F, R>(&'a mut self, offset: usize, f: F) -> R
where F: FnOnce(SendPayload<'a>) -> R,

Calls f with contiguous sequences of readable bytes in the buffer without advancing the reading pointer. Read more
source§

impl Eq for RingBuffer

source§

impl StructuralPartialEq for RingBuffer

Auto Trait Implementations§

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.

§

impl<T> Instrument for T

§

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

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

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<CC, BC, Meta> RecvFrameContext<BC, Meta> for CC
where Meta: ReceivableFrameMeta<CC, BC>,

source§

fn receive_frame<B>(&mut self, bindings_ctx: &mut BC, metadata: Meta, frame: B)
where B: BufferMut + Debug,

Receive a frame. Read more
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<CC, BC, Meta> SendFrameContext<BC, Meta> for CC
where Meta: SendableFrameMeta<CC, BC>,

source§

fn send_frame<S>( &mut self, bindings_ctx: &mut BC, metadata: Meta, frame: S ) -> Result<(), S>
where S: Serializer, <S as Serializer>::Buffer: BufferMut,

Send a frame. Read more
source§

impl<Meta, BC> SendableFrameMeta<FakeFrameCtx<Meta>, BC> for Meta

source§

fn send_meta<S>( self, core_ctx: &mut FakeFrameCtx<Meta>, _bindings_ctx: &mut BC, frame: S ) -> Result<(), S>
where S: Serializer, <S as Serializer>::Buffer: BufferMut,

Sends this frame metadata to the provided contexts.
source§

impl<T> Takeable for T
where T: Default,

source§

fn take(&mut self) -> T

Replaces self with an implementor-defined “empty” value.
source§

impl<Id, CC, BC> TimerHandler<BC, Id> for CC
where Id: HandleableTimer<CC, BC>,

source§

fn handle_timer(&mut self, bindings_ctx: &mut BC, id: Id)

Handle a timer firing.
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.
§

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

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<B, A> LockBefore<B> for A
where B: LockAfter<A>,