      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
     71
     72
     73
     74
     75
     76
     77
     78
     79
     80
     81
     82
     83
     84
     85
     86
     87
     88
     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109

    // Copyright 2018 Amanieu d'Antras
    //
    // Licensed under the Apache License, Version 2.0, <LICENSE-APACHE or
    // http://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.

    //! This library provides type-safe and fully-featured `Mutex` and `RwLock`
    //! types which wrap a simple raw mutex or rwlock type. This has several
    //! benefits: not only does it eliminate a large portion of the work in
    //! implementing custom lock types, it also allows users to write code which is
    //! generic with regards to different lock implementations.
    //!
    //! Basic usage of this crate is very straightforward:
    //!
    //! 1. Create a raw lock type. This should only contain the lock state, not any
    //!    data protected by the lock.
    //! 2. Implement the `RawMutex` trait for your custom lock type.
    //! 3. Export your mutex as a type alias for `lock_api::Mutex`, and
    //!    your mutex guard as a type alias for `lock_api::MutexGuard`.
    //!    See the [example](#example) below for details.
    //!
    //! This process is similar for RwLocks, except that two guards need to be
    //! exported instead of one. (Or 3 guards if your type supports upgradable read
    //! locks, see [extension traits](#extension-traits) below for details)
    //!
    //! # Example
    //!
    //! ```
    //! use lock_api::{RawMutex, Mutex, GuardSend};
    //! use std::sync::atomic::{AtomicBool, Ordering, ATOMIC_BOOL_INIT};
    //!
    //! // 1. Define our raw lock type
    //! pub struct RawSpinlock(AtomicBool);
    //!
    //! // 2. Implement RawMutex for this type
    //! unsafe impl RawMutex for RawSpinlock {
    //!     const INIT: RawSpinlock = RawSpinlock(ATOMIC_BOOL_INIT);
    //!
    //!     // A spinlock guard can be sent to another thread and unlocked there
    //!     type GuardMarker = GuardSend;
    //!
    //!     fn lock(&self) {
    //!         // Note: This isn't the best way of implementing a spinlock, but it
    //!         // suffices for the sake of this example.
    //!         while !self.try_lock() {}
    //!     }
    //!
    //!     fn try_lock(&self) -> bool {
    //!         self.0.swap(true, Ordering::Acquire)
    //!     }
    //!
    //!     fn unlock(&self) {
    //!         self.0.store(false, Ordering::Release);
    //!     }
    //! }
    //!
    //! // 3. Export the wrappers. This are the types that your users will actually use.
    //! pub type Spinlock<T> = lock_api::Mutex<RawSpinlock, T>;
    //! pub type SpinlockGuard<'a, T> = lock_api::MutexGuard<'a, RawSpinlock, T>;
    //! ```
    //!
    //! # Extension traits
    //!
    //! In addition to basic locking & unlocking functionality, you have the option
    //! of exposing additional functionality in your lock types by implementing
    //! additional traits for it. Examples of extension features include:
    //!
    //! - Fair unlocking (`RawMutexFair`, `RawRwLockFair`)
    //! - Lock timeouts (`RawMutexTimed`, `RawRwLockTimed`)
    //! - Downgradable write locks (`RawRwLockDowngradable`)
    //! - Recursive read locks (`RawRwLockRecursive`)
    //! - Upgradable read locks (`RawRwLockUpgrade`)
    //!
    //! The `Mutex` and `RwLock` wrappers will automatically expose this additional
    //! functionality if the raw lock type implements these extension traits.
    //!
    //! # Cargo features
    //!
    //! This crate supports two cargo features:
    //!
    //! - `owning_ref`: Allows your lock types to be used with the `owning_ref` crate.
    //! - `nightly`: Enables nightly-only features. At the moment the only such
    //!   feature is `const fn` constructors for lock types.

    #![no_std]
    #![warn(missing_docs)]
    #![cfg_attr(feature = "nightly", feature(const_fn))]

    #[macro_use]
    extern crate scopeguard;

    #[cfg(feature = "owning_ref")]
    extern crate owning_ref;

    /// Marker type which indicates that the Guard type for a lock is `Send`.
    pub struct GuardSend(());

    /// Marker type which indicates that the Guard type for a lock is not `Send`.
    pub struct GuardNoSend(*mut ());

    mod mutex;
    pub use mutex::*;

    mod remutex;
    pub use remutex::*;

    mod rwlock;
    pub use rwlock::*;

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

Search multiple things at once by splitting your query with comma (e.g., `str,u8` or `String,struct:Vec,test`)