Struct FlushGate 

pub struct FlushGate<T> { /* private fields */ }

FlushGate is a state machine for gating message writes during an initial flush.

Implementations

impl<T> FlushGate<T>

pub fn new() -> Self

Create a new FlushGate.

pub fn active(&self) -> bool

Whether the flush is currently active.

pub fn pending_count(&self) -> usize

Number of pending items in the queue.

pub fn start(&mut self)

Mark flush as in-progress. enqueue() will start queuing items.

pub fn end(&mut self) -> Vec<T>

End the flush and return any queued items for draining. Caller is responsible for sending the returned items.

pub fn enqueue(&mut self, items: Vec<T>) -> bool

If flush is active, queue the items and return true. If flush is not active, return false (caller should send directly).

pub fn enqueue_one(&mut self, item: T) -> bool

Enqueue a single item.

pub fn drop(&mut self) -> usize

Discard all queued items (permanent transport close). Returns the number of items dropped.

pub fn deactivate(&mut self)

Clear the active flag without dropping queued items. Used when the transport is replaced - the new transport’s flush will drain the pending items.

Trait Implementations

impl<T: Clone> Clone for FlushGate<T>

fn clone(&self) -> FlushGate<T>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for FlushGate<T>

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

Formats the value using the given formatter.

impl<T> Default for FlushGate<T>

fn default() -> Self

Returns the “default value” for a type.