# Module futures::sink [−] [src]

Asynchronous sinks

This module contains the `Sink` trait, along with a number of adapter types for it. An overview is available in the documentation for the trait itself.

You can find more information/tutorials about streams online at https://tokio.rs

## Structs

Buffer | Sink for the `Sink::buffer` combinator, which buffers up to some fixed number of values when the underlying sink is unable to accept them.
Fanout | Sink that clones incoming items and forwards them to two sinks at the same time.
Flush | Future for the `Sink::flush` combinator, which polls the sink until all data has been flushed.
Send | Future for the `Sink::send` combinator, which sends a value to a sink and then waits until the sink has fully flushed.
SendAll | Future for the `Sink::send_all` combinator, which sends a stream of values to a sink and then waits until the sink has fully flushed those values.
SinkFromErr | A sink combinator to change the error type of a sink.
SinkMapErr | Sink for the `Sink::sink_map_err` combinator.
Wait | A sink combinator which converts an asynchronous sink to a blocking sink.
With | Sink for the `Sink::with` combinator, chaining a computation to run prior to pushing a value into the underlying sink.
WithFlatMap | Sink for the `Sink::with_flat_map` combinator, chaining a computation that returns an iterator to run prior to pushing a value into the underlying sink

## Traits

Sink | A `Sink` is a value into which other values can be sent, asynchronously.

## Type Definitions

BoxSink | A type alias for `Box<Sink + Send>`

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)