Struct futures_intrusive::channel::shared::GenericSender

pub struct GenericSender<MutexType, T, A> where
    MutexType: RawMutex,
    A: RingBuf<Item = T>,
    T: 'static,  { /* fields omitted */ }

The sending side of a channel which can be used to exchange values between concurrent tasks.

Values can be sent into the channel through send. The returned Future will get resolved when the value has been stored inside the channel.

Methods

impl<MutexType, T, A> GenericSender<MutexType, T, A> where
    MutexType: 'static + RawMutex,
    A: 'static + RingBuf<Item = T>, 

pub fn send(&self, value: T) -> ChannelSendFuture<MutexType, T>

Returns a future that gets fulfilled when the value has been written to the channel. If the channel gets closed while the send is in progress, sending the value will fail, and the future will deliver the value back.

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

Attempt to send the value without waiting.

This operation is not supported for unbuffered channels and will panic if the capacity of the RingBuf is zero. The reason for this is that the actual value transfer on unbuffered channels always happens when a receiving task copies the value out of the sending task while it is waiting. If the sending task does not wait, the value can not be transferred. Since this method can therefore never yield a reasonable result with unbuffered channels, it panics in order to highlight the use of an inappropriate API.

pub fn close(&self) -> CloseStatus

Closes the channel. All pending future send attempts will fail. Receive attempts will continue to succeed as long as there are items stored inside the channel. Further attempts will return None.

Trait Implementations

impl<MutexType, T, A> Clone for GenericSender<MutexType, T, A> where
    MutexType: RawMutex,
    A: RingBuf<Item = T>, 

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<MutexType, T, A> Debug for GenericSender<MutexType, T, A> where
    MutexType: RawMutex,
    A: RingBuf<Item = T>, 

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

Formats the value using the given formatter.

impl<MutexType, T, A> Drop for GenericSender<MutexType, T, A> where
    MutexType: RawMutex,
    A: RingBuf<Item = T>, 

fn drop(&mut self)

Executes the destructor for this type.