Skip to main content

OutputQueue

Struct OutputQueue 

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

Manages a queue of outbound replication messages.

The queue has a configurable maximum size. When the queue is full or shut down, enqueue returns false. Messages can be dequeued in batches for efficient network I/O.

Implementations§

Source§

impl OutputQueue

Source

pub fn new(max_queue_size: usize) -> Self

Create a new output queue with the given maximum capacity.

Source

pub fn enqueue(&self, message: Vec<u8>) -> bool

Enqueue a message.

Returns true if the message was accepted, false if the queue is full or has been shut down.

Source

pub fn dequeue_batch(&self, max: usize) -> Vec<Vec<u8>>

Dequeue up to max messages in a batch.

Returns the messages in FIFO order. If fewer than max messages are available, returns all of them.

Source

pub fn len(&self) -> usize

Return the number of messages currently in the queue.

Source

pub fn is_empty(&self) -> bool

Return true if the queue is empty.

Source

pub fn shutdown(&self)

Shut down the queue. No more messages will be accepted.

Source

pub fn is_shutdown(&self) -> bool

Return true if the queue has been shut down.

Source

pub fn clear(&self)

Clear all messages from the queue.

Trait Implementations§

Source§

impl Debug for OutputQueue

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, 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.
Source§

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

Source§

fn vzip(self) -> V

Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,