Struct muxrpc::CancelSource

pub struct CancelSource<W: AsyncWrite>(_);

This future can be used to signal to the peer that you are no longer interested in receiving more values from this source.

Note that if you don't poll this future, you must use the close method instead (otherwise, there might be unclosed sinks under the hood).

Methods

impl<W: AsyncWrite> CancelSource<W>

pub fn close(self) -> CloseCancelSource<W>

Close this CancelSource. If it has not been run as a future, you must instead run the future returned from this method.

Trait Implementations

impl<W: AsyncWrite> Future for CancelSource<W>

type Item = ()

A successful value

type Error = Option<Error>

An error

fn poll(&mut self, cx: &mut Context) -> Poll<Self::Item, Self::Error>

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.