Struct futures::sink::Close

#[must_use = "futures do nothing unless polled"]
pub struct Close<S> { /* fields omitted */ }

Future for the close combinator, which polls the sink until all data has been closed.

Methods

impl<S> Close<S> where
    S: Sink, 

pub fn get_ref(&self) -> Option<&S>

Get a shared reference to the inner sink. Returns None if the sink has already been closed.

pub fn get_mut(&mut self) -> Option<&mut S>

Get a mutable reference to the inner sink. Returns None if the sink has already been closed.

pub fn into_inner(self) -> Option<S>

Consume the Close and return the inner sink. Returns None if the sink has already been closed.

Trait Implementations

impl<S> Debug for Close<S> where
    S: Debug, 

fn fmt(&self, __arg_0: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.

impl<S> Future for Close<S> where
    S: Sink, 

type Item = S

A successful value

type Error = <S as Sink>::SinkError

An error

fn poll(&mut self, cx: &mut Context) -> Result<Async<S>, <S as Sink>::SinkError>

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