Struct Channel

pub(crate) struct Channel<T> {
    inner: Mutex<Inner>,
    _marker: PhantomData<T>,
}

🔬This is a nightly-only experimental API. (mpmc_channel #126840)

Zero-capacity channel.

Fields

inner: Mutex<Inner>

🔬This is a nightly-only experimental API. (mpmc_channel #126840)

Inner representation of the channel.

_marker: PhantomData<T>

🔬This is a nightly-only experimental API. (mpmc_channel #126840)

Indicates that dropping a Channel<T> may drop values of type T.

Implementations

impl<T> Channel<T>

pub(crate) fn new() -> Self

🔬This is a nightly-only experimental API. (mpmc_channel #126840)

Constructs a new zero-capacity channel.

pub(crate) unsafe fn write(&self, token: &mut Token, msg: T) -> Result<(), T>

🔬This is a nightly-only experimental API. (mpmc_channel #126840)

Writes a message into the packet.

pub(crate) unsafe fn read(&self, token: &mut Token) -> Result<T, ()>

🔬This is a nightly-only experimental API. (mpmc_channel #126840)

Reads a message from the packet.

pub(crate) fn try_send(&self, msg: T) -> Result<(), TrySendError<T>>

🔬This is a nightly-only experimental API. (mpmc_channel #126840)

Attempts to send a message into the channel.

pub(crate) fn send( &self, msg: T, deadline: Option<Instant>, ) -> Result<(), SendTimeoutError<T>>

🔬This is a nightly-only experimental API. (mpmc_channel #126840)

Sends a message into the channel.

pub(crate) fn try_recv(&self) -> Result<T, TryRecvError>

🔬This is a nightly-only experimental API. (mpmc_channel #126840)

Attempts to receive a message without blocking.

pub(crate) fn recv( &self, deadline: Option<Instant>, ) -> Result<T, RecvTimeoutError>

🔬This is a nightly-only experimental API. (mpmc_channel #126840)

Receives a message from the channel.

pub(crate) fn disconnect(&self) -> bool

🔬This is a nightly-only experimental API. (mpmc_channel #126840)

Disconnects the channel and wakes up all blocked senders and receivers.

Returns true if this call disconnected the channel.

pub(crate) fn len(&self) -> usize

🔬This is a nightly-only experimental API. (mpmc_channel #126840)

Returns the current number of messages inside the channel.

pub(crate) fn capacity(&self) -> Option<usize>

🔬This is a nightly-only experimental API. (mpmc_channel #126840)

Returns the capacity of the channel.

pub(crate) fn is_empty(&self) -> bool

🔬This is a nightly-only experimental API. (mpmc_channel #126840)

Returns true if the channel is empty.

pub(crate) fn is_full(&self) -> bool

🔬This is a nightly-only experimental API. (mpmc_channel #126840)

Returns true if the channel is full.