     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
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70

    // Copyright 2014 The Rust Project Developers. See the COPYRIGHT
    // file at the top-level directory of this distribution and at
    // http://rust-lang.org/COPYRIGHT.
    //
    // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
    // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
    // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
    // option. This file may not be copied, modified, or distributed
    // except according to those terms.

    use time::Duration;
    use sys_common::mutex::{self, Mutex};
    use sys::condvar as imp;

    /// An OS-based condition variable.
    ///
    /// This structure is the lowest layer possible on top of the OS-provided
    /// condition variables. It is consequently entirely unsafe to use. It is
    /// recommended to use the safer types at the top level of this crate instead of
    /// this type.
    pub struct Condvar(imp::Condvar);

    impl Condvar {
        /// Creates a new condition variable for use.
        ///
        /// Behavior is undefined if the condition variable is moved after it is
        /// first used with any of the functions below.
        pub const fn new() -> Condvar { Condvar(imp::Condvar::new()) }

        /// Prepares the condition variable for use.
        ///
        /// This should be called once the condition variable is at a stable memory
        /// address.
        #[inline]
        pub unsafe fn init(&mut self) { self.0.init() }

        /// Signals one waiter on this condition variable to wake up.
        #[inline]
        pub unsafe fn notify_one(&self) { self.0.notify_one() }

        /// Awakens all current waiters on this condition variable.
        #[inline]
        pub unsafe fn notify_all(&self) { self.0.notify_all() }

        /// Waits for a signal on the specified mutex.
        ///
        /// Behavior is undefined if the mutex is not locked by the current thread.
        /// Behavior is also undefined if more than one mutex is used concurrently
        /// on this condition variable.
        #[inline]
        pub unsafe fn wait(&self, mutex: &Mutex) { self.0.wait(mutex::raw(mutex)) }

        /// Waits for a signal on the specified mutex with a timeout duration
        /// specified by `dur` (a relative time into the future).
        ///
        /// Behavior is undefined if the mutex is not locked by the current thread.
        /// Behavior is also undefined if more than one mutex is used concurrently
        /// on this condition variable.
        #[inline]
        pub unsafe fn wait_timeout(&self, mutex: &Mutex, dur: Duration) -> bool {
            self.0.wait_timeout(mutex::raw(mutex), dur)
        }

        /// Deallocates all resources associated with this condition variable.
        ///
        /// Behavior is undefined if there are current or will be future users of
        /// this condition variable.
        #[inline]
        pub unsafe fn destroy(&self) { self.0.destroy() }
    }

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