pub struct Emitter<T> { /* private fields */ }Expand description
A handle for emitting values from an async_stream generator.
The generator closure receives an Emitter<T> as its argument.
Implementations§
Source§impl<T> Emitter<T>
impl<T> Emitter<T>
Sourcepub fn emit(&mut self, value: T) -> impl FusedFuture<Output = ()>
pub fn emit(&mut self, value: T) -> impl FusedFuture<Output = ()>
Returns a Future that emits value as the next stream item.
The returned future must be awaited immediately. On its first poll it
yields Poll::Pending, handing control back to the stream consumer so it
can observe the emitted value. On the next poll (triggered by the
consumer calling poll_next again) it completes with Poll::Ready(()),
resuming the generator.
§Panics
Panics if emit is called a second time before the previous future has
been awaited, because doing so would silently overwrite the unconsumed
value.
Auto Trait Implementations§
impl<T> !RefUnwindSafe for Emitter<T>
impl<T> !UnwindSafe for Emitter<T>
impl<T> Freeze for Emitter<T>
impl<T> Send for Emitter<T>where
T: Send,
impl<T> Sync for Emitter<T>where
T: Send,
impl<T> Unpin for Emitter<T>
impl<T> UnsafeUnpin for Emitter<T>
Blanket Implementations§
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
Mutably borrows from an owned value. Read more
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> ⓘ
Converts
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> ⓘ
Converts
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