Skip to main content

PortBuffer

Struct PortBuffer 

Source
pub struct PortBuffer { /* private fields */ }
Expand description

A buffer that sits between an output port and an input port.

Implementations§

Source§

impl PortBuffer

Source

pub fn new(strategy: BufferStrategy, label: &str) -> Self

Create a new port buffer with the given strategy.

Source

pub fn push(&mut self, token: FrameToken) -> bool

Push a frame token into the buffer.

Returns true if the frame was accepted, false if it was dropped due to overflow (for bounded strategies).

Source

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

Pop the next frame token from the buffer.

Source

pub fn peek(&self) -> Option<&FrameToken>

Peek at the next frame token without removing it.

Source

pub fn len(&self) -> usize

Get the current number of frames in the buffer.

Source

pub fn is_empty(&self) -> bool

Check whether the buffer is empty.

Source

pub fn status(&self) -> BufferStatus

Get the current buffer status.

Source

pub fn strategy(&self) -> BufferStrategy

Get the buffering strategy.

Source

pub fn max_capacity(&self) -> usize

Get the maximum capacity (0 for unbounded).

Source

pub fn total_pushed(&self) -> u64

Get the total number of frames pushed.

Source

pub fn total_popped(&self) -> u64

Get the total number of frames popped.

Source

pub fn dropped(&self) -> u64

Get the number of dropped frames.

Source

pub fn label(&self) -> &str

Get the buffer label.

Source

pub fn clear(&mut self)

Clear all buffered frames.

Source

pub fn drain_all(&mut self) -> Vec<FrameToken>

Drain all frames from the buffer as a vector.

Source

pub fn fill_ratio(&self) -> f64

Get fill ratio (0.0 to 1.0). Returns 0.0 for unbounded buffers.

Trait Implementations§

Source§

impl Display for PortBuffer

Source§

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

Formats the value using the given formatter. Read more

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.

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
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.