     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59

    use sink::Sink;
    use executor;

    /// A sink combinator which converts an asynchronous sink to a **blocking
    /// sink**.
    ///
    /// Created by the `Sink::wait` method, this function transforms any sink into a
    /// blocking version. This is implemented by blocking the current thread when a
    /// sink is otherwise unable to make progress.
    #[must_use = "sinks do nothing unless used"]
    #[derive(Debug)]
    pub struct Wait<S> {
        sink: executor::Spawn<S>,
    }

    pub fn new<S: Sink>(s: S) -> Wait<S> {
        Wait {
            sink: executor::spawn(s),
        }
    }

    impl<S: Sink> Wait<S> {
        /// Sends a value to this sink, blocking the current thread until it's able
        /// to do so.
        ///
        /// This function will take the `value` provided and call the underlying
        /// sink's `start_send` function until it's ready to accept the value. If
        /// the function returns `NotReady` then the current thread is blocked
        /// until it is otherwise ready to accept the value.
        ///
        /// # Return value
        ///
        /// If `Ok(())` is returned then the `value` provided was successfully sent
        /// along the sink, and if `Err(e)` is returned then an error occurred
        /// which prevented the value from being sent.
        pub fn send(&mut self, value: S::SinkItem) -> Result<(), S::SinkError> {
            self.sink.wait_send(value)
        }

        /// Flushes any buffered data in this sink, blocking the current thread
        /// until it's entirely flushed.
        ///
        /// This function will call the underlying sink's `poll_complete` method
        /// until it returns that it's ready to proceed. If the method returns
        /// `NotReady` the current thread will be blocked until it's otherwise
        /// ready to proceed.
        pub fn flush(&mut self) -> Result<(), S::SinkError> {
            self.sink.wait_flush()
        }

        /// Close this sink, blocking the current thread until it's entirely closed.
        ///
        /// This function will call the underlying sink's `close` method
        /// until it returns that it's closed. If the method returns
        /// `NotReady` the current thread will be blocked until it's otherwise closed.
        pub fn close(&mut self) -> Result<(), S::SinkError> {
            self.sink.wait_close()
        }
    }

# 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`)