Skip to main content

BoundedChannel

Struct BoundedChannel 

Source
pub struct BoundedChannel<T> { /* private fields */ }
Expand description

A bounded channel with configurable backpressure handling.

Implementations§

Source§

impl<T> BoundedChannel<T>

Source

pub fn new(capacity: usize, strategy: BackpressureStrategy) -> Self

Creates a new bounded channel with the given capacity and backpressure strategy.

Source

pub fn send(&self, item: T) -> SynthResult<bool>

Sends an item through the channel.

Returns Ok(true) if the item was sent, Ok(false) if it was dropped, or Err if the channel is closed.

Source

pub fn send_timeout(&self, item: T, timeout: Duration) -> SynthResult<bool>

Sends an item with a timeout.

Source

pub fn recv(&self) -> Option<T>

Receives an item from the channel.

Returns None if the channel is closed and empty.

Source

pub fn recv_timeout(&self, timeout: Duration) -> Option<T>

Receives an item with a timeout.

Source

pub fn try_recv(&self) -> Option<T>

Tries to receive an item without blocking.

Source

pub fn close(&self)

Closes the channel.

Source

pub fn is_closed(&self) -> bool

Returns whether the channel is closed.

Source

pub fn len(&self) -> usize

Returns the current number of items in the buffer.

Source

pub fn is_empty(&self) -> bool

Returns whether the buffer is empty.

Source

pub fn capacity(&self) -> usize

Returns the channel capacity.

Source

pub fn stats(&self) -> ChannelStats

Returns channel statistics.

Trait Implementations§

Source§

impl<T> Clone for BoundedChannel<T>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

impl<T> Freeze for BoundedChannel<T>

§

impl<T> RefUnwindSafe for BoundedChannel<T>

§

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

§

impl<T> Sync for BoundedChannel<T>
where T: Send,

§

impl<T> Unpin for BoundedChannel<T>

§

impl<T> UnwindSafe for BoundedChannel<T>

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§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

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>,

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