rwlock.rs.html -- source
Description: Source to the Rust file `src/libstd/sys_common/rwlock.rs`.
Keywords: rust, rustlang, rust-lang

     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

    use crate::sys::rwlock as imp;

    /// An OS-based reader-writer lock.
    ///
    /// This structure is entirely unsafe and serves as the lowest layer of a
    /// cross-platform binding of system rwlocks. It is recommended to use the
    /// safer types at the top level of this crate instead of this type.
    pub struct RWLock(imp::RWLock);

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

        /// Acquires shared access to the underlying lock, blocking the current
        /// thread to do so.
        ///
        /// Behavior is undefined if the rwlock has been moved between this and any
        /// previous method call.
        #[inline]
        pub unsafe fn read(&self) { self.0.read() }

        /// Attempts to acquire shared access to this lock, returning whether it
        /// succeeded or not.
        ///
        /// This function does not block the current thread.
        ///
        /// Behavior is undefined if the rwlock has been moved between this and any
        /// previous method call.
        #[inline]
        pub unsafe fn try_read(&self) -> bool { self.0.try_read() }

        /// Acquires write access to the underlying lock, blocking the current thread
        /// to do so.
        ///
        /// Behavior is undefined if the rwlock has been moved between this and any
        /// previous method call.
        #[inline]
        pub unsafe fn write(&self) { self.0.write() }

        /// Attempts to acquire exclusive access to this lock, returning whether it
        /// succeeded or not.
        ///
        /// This function does not block the current thread.
        ///
        /// Behavior is undefined if the rwlock has been moved between this and any
        /// previous method call.
        #[inline]
        pub unsafe fn try_write(&self) -> bool { self.0.try_write() }

        /// Unlocks previously acquired shared access to this lock.
        ///
        /// Behavior is undefined if the current thread does not have shared access.
        #[inline]
        pub unsafe fn read_unlock(&self) { self.0.read_unlock() }

        /// Unlocks previously acquired exclusive access to this lock.
        ///
        /// Behavior is undefined if the current thread does not currently have
        /// exclusive access.
        #[inline]
        pub unsafe fn write_unlock(&self) { self.0.write_unlock() }

        /// Destroys OS-related resources with this RWLock.
        ///
        /// Behavior is undefined if there are any currently active users of this
        /// lock.
        #[inline]
        pub unsafe fn destroy(&self) { self.0.destroy() }
    }