[−][src]Struct tokio_signal::CtrlC

#[must_use = "streams do nothing unless polled"]
pub struct CtrlC { /* fields omitted */ }

Represents a stream which receives "ctrl-c" notifications sent to the process.

In general signals are handled very differently across Unix and Windows, but this is somewhat cross platform in terms of how it can be handled. A ctrl-c event to a console process can be represented as a stream for both Windows and Unix.

Note that there are a number of caveats listening for signals, and you may wish to read up on the documentation in the unix or windows module to take a peek.

Notably, a notification to this process notifies all streams listening to this event. Moreover, the notifications are coalesced if they aren't processed quickly enough. This means that if two notifications are received back-to-back, then the stream may only receive one item about the two notifications.

Methods

impl CtrlC[src]

pub fn new() -> Result<Self>[src]

Creates a new stream which receives "ctrl-c" notifications sent to the process.

This function binds to the default reactor.

pub fn with_handle(handle: &Handle) -> Result<Self>[src]

Creates a new stream which receives "ctrl-c" notifications sent to the process.

This function binds to reactor specified by handle.

Trait Implementations

impl Debug for CtrlC[src]

impl Stream for CtrlC[src]

type Item = ()

Values yielded by the stream.

Auto Trait Implementations

impl Sync for CtrlC

impl Send for CtrlC

impl Unpin for CtrlC

impl !RefUnwindSafe for CtrlC

impl !UnwindSafe for CtrlC

Blanket Implementations

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, [src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

impl<T> Any for T where
    T: 'static + ?Sized, [src]

impl<T> StreamExt for T where
    T: Stream + ?Sized, [src]

fn next(&mut self) -> Next<Self> where
    Self: Unpin, [src]

Creates a future that resolves to the next item in the stream. Read more

fn into_future(self) -> StreamFuture<Self> where
    Self: Unpin, [src]

Converts this stream into a future of (next_item, tail_of_stream). If the stream terminates, then the next item is [None]. Read more

fn map<T, F>(self, f: F) -> Map<Self, F> where
    F: FnMut(Self::Item) -> T, [src]

Maps this stream's items to a different type, returning a new stream of the resulting type. Read more

fn enumerate(self) -> Enumerate<Self>[src]

Creates a stream which gives the current iteration count as well as the next value. Read more

fn filter<Fut, F>(self, f: F) -> Filter<Self, Fut, F> where
    F: FnMut(&Self::Item) -> Fut,
    Fut: Future<Output = bool>, [src]

Filters the values produced by this stream according to the provided asynchronous predicate. Read more

fn filter_map<Fut, T, F>(self, f: F) -> FilterMap<Self, Fut, F> where
    F: FnMut(Self::Item) -> Fut,
    Fut: Future<Output = Option<T>>, [src]

Filters the values produced by this stream while simultaneously mapping them to a different type according to the provided asynchronous closure. Read more

fn then<Fut, F>(self, f: F) -> Then<Self, Fut, F> where
    F: FnMut(Self::Item) -> Fut,
    Fut: Future, [src]

Computes from this stream's items new items of a different type using an asynchronous closure. Read more

fn collect<C>(self) -> Collect<Self, C> where
    C: Default + Extend<Self::Item>, [src]

Collect all of the values of this stream into a vector, returning a future representing the result of that computation. Read more

fn concat(self) -> Concat<Self> where
    Self::Item: Extend<<Self::Item as IntoIterator>::Item>,
    Self::Item: IntoIterator,
    Self::Item: Default, [src]

Concatenate all items of a stream into a single extendable destination, returning a future representing the end result. Read more

fn fold<T, Fut, F>(self, init: T, f: F) -> Fold<Self, Fut, T, F> where
    F: FnMut(T, Self::Item) -> Fut,
    Fut: Future<Output = T>, [src]

Execute an accumulating asynchronous computation over a stream, collecting all the values into one final result. Read more

fn flatten(self) -> Flatten<Self> where
    Self::Item: Stream, [src]

Flattens a stream of streams into just one continuous stream. Read more

fn skip_while<Fut, F>(self, f: F) -> SkipWhile<Self, Fut, F> where
    F: FnMut(&Self::Item) -> Fut,
    Fut: Future<Output = bool>, [src]

Skip elements on this stream while the provided asynchronous predicate resolves to true. Read more

fn take_while<Fut, F>(self, f: F) -> TakeWhile<Self, Fut, F> where
    F: FnMut(&Self::Item) -> Fut,
    Fut: Future<Output = bool>, [src]

Take elements from this stream while the provided asynchronous predicate resolves to true. Read more

fn for_each<Fut, F>(self, f: F) -> ForEach<Self, Fut, F> where
    F: FnMut(Self::Item) -> Fut,
    Fut: Future<Output = ()>, [src]

Runs this stream to completion, executing the provided asynchronous closure for each element on the stream. Read more

fn for_each_concurrent<Fut, F, impl Into>>(
    self,
    limit: impl Into>,
    f: F
) -> ForEachConcurrent<Self, Fut, F> where
    F: FnMut(Self::Item) -> Fut,
    Fut: Future<Output = ()>,
    impl Into>: Into<Option<usize>>, [src]

Runs this stream to completion, executing the provided asynchronous closure for each element on the stream concurrently as elements become available. Read more

fn take(self, n: u64) -> Take<Self>[src]

Creates a new stream of at most n items of the underlying stream. Read more

fn skip(self, n: u64) -> Skip<Self>[src]

Creates a new stream which skips n items of the underlying stream. Read more

fn fuse(self) -> Fuse<Self>[src]

Fuse a stream such that poll_next will never again be called once it has finished. This method can be used t turn any Stream into a FusedStream. Read more

fn by_ref(&mut self) -> &mut Self[src]

Borrows a stream, rather than consuming it. Read more

fn catch_unwind(self) -> CatchUnwind<Self> where
    Self: UnwindSafe, [src]

Catches unwinding panics while polling the stream. Read more

fn boxed(self) -> Pin<Box<Self>>[src]

Wrap the stream in a Box, pinning it. Read more

fn buffered(self, n: usize) -> Buffered<Self> where
    Self::Item: Future, [src]

An adaptor for creating a buffered list of pending futures. Read more

fn buffer_unordered(self, n: usize) -> BufferUnordered<Self> where
    Self::Item: Future, [src]

An adaptor for creating a buffered list of pending futures (unordered). Read more

fn zip<St>(self, other: St) -> Zip<Self, St> where
    St: Stream, [src]

An adapter for zipping two streams together. Read more

fn chain<St>(self, other: St) -> Chain<Self, St> where
    St: Stream<Item = Self::Item>, [src]

Adapter for chaining two stream. Read more

fn peekable(self) -> Peekable<Self>[src]

Creates a new stream which exposes a peek method. Read more

fn chunks(self, capacity: usize) -> Chunks<Self>[src]

An adaptor for chunking up items of the stream inside a vector. Read more

fn inspect<F>(self, f: F) -> Inspect<Self, F> where
    F: FnMut(&Self::Item), [src]

Do something with each item of this stream, afterwards passing it on. Read more

fn left_stream<B>(self) -> Either<Self, B> where
    B: Stream<Item = Self::Item>, [src]

Wrap this stream in an Either stream, making it the left-hand variant of that Either. Read more

fn right_stream<B>(self) -> Either<B, Self> where
    B: Stream<Item = Self::Item>, [src]

Wrap this stream in an Either stream, making it the right-hand variant of that Either. Read more

fn poll_next_unpin(&mut self, cx: &mut Context) -> Poll<Option<Self::Item>> where
    Self: Unpin, [src]

A convenience method for calling [Stream::poll_next] on [Unpin] stream types. Read more

fn select_next_some(&mut self) -> SelectNextSome<Self> where
    Self: Unpin + FusedStream, [src]

Returns a [Future] that resolves when the next item in this stream is ready. Read more