Struct tokio_stream::wrappers::CtrlBreakStream

pub struct CtrlBreakStream { /* fields omitted */ }

This is supported on Windows and crate feature signal only.

A wrapper around CtrlBreak that implements Stream.

Implementations

impl CtrlBreakStream

pub fn new(interval: CtrlBreak) -> Self

Create a new CtrlBreakStream.

pub fn into_inner(self) -> CtrlBreak

Get back the inner CtrlBreak.

Trait Implementations

impl AsMut<CtrlBreak> for CtrlBreakStream

fn as_mut(&mut self) -> &mut CtrlBreak

Performs the conversion.

impl AsRef<CtrlBreak> for CtrlBreakStream

fn as_ref(&self) -> &CtrlBreak

Performs the conversion.

impl Debug for CtrlBreakStream

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

Formats the value using the given formatter.

impl Stream for CtrlBreakStream

type Item = ()

Values yielded by the stream.

fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<()>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

pub fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.