pub struct SinkSendable<'w, OS, OM> {
output: Pin<&'w mut OS>,
tw: PhantomData<fn(OM)>,
}Expand description
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§
Source§impl<'w, OS, OM> SinkSendable<'w, OS, OM>where
OS: Sink<OM>,
impl<'w, OS, OM> SinkSendable<'w, OS, OM>where
OS: Sink<OM>,
Sourcepub fn send(self, item: OM) -> Result<(), OS::Error>
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.)
Auto Trait Implementations§
impl<'w, OS, OM> !UnwindSafe for SinkSendable<'w, OS, OM>
impl<'w, OS, OM> Freeze for SinkSendable<'w, OS, OM>
impl<'w, OS, OM> RefUnwindSafe for SinkSendable<'w, OS, OM>where
OS: RefUnwindSafe,
impl<'w, OS, OM> Send for SinkSendable<'w, OS, OM>where
OS: Send,
impl<'w, OS, OM> Sync for SinkSendable<'w, OS, OM>where
OS: Sync,
impl<'w, OS, OM> Unpin for SinkSendable<'w, OS, OM>
impl<'w, OS, OM> UnsafeUnpin for SinkSendable<'w, OS, OM>
Blanket Implementations§
Source§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
Source§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more