Struct SinkSendable

pub struct SinkSendable<'w, OS, OM> {
    output: Pin<&'w mut OS>,
    tw: PhantomData<fn(OM)>,
}

A [Sink] which is ready to receive an item

Produced by SinkPrepareExt::prepare_send_from. See there for the overview docs.

This references an output sink OS. It offers the ability to write into the sink without blocking, (and constitutes a proof token that the sink has declared itself ready for that).

The only useful method is send.

SinkSendable has no drop glue and can be freely dropped, for example if you prepare to send a message and then encounter an error when producing the output message.

Fields

output: Pin<&'w mut OS>

Reference to underlying output sink.

tw: PhantomData<fn(OM)>

Marker to ensure that OM is used.

Implementations

impl<'w, OS, OM> SinkSendable<'w, OS, OM>

where OS: Sink<OM>,

pub fn send(self, item: OM) -> Result<(), OS::Error>

Synchronously send an item into OS, which is a [Sink]

Can fail if the sink OS reports an error.

(However, the existence of the SinkSendable demonstrates that the sink reported itself ready for sending, so this call is synchronous, avoiding cancellation hazards.)