pinned 0.1.0

Synchronisation primitives for !Send tasks.
Documentation 
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

use std::marker::PhantomData;
use std::result;

use thiserror::Error;

/// Error returned from the [`RwLock::try_read`](super::RwLock::try_read) and
/// [`RwLock::try_write`](super::RwLock::try_write)
/// functions.
///
/// `RwLock::try_read` operation will only fail if the lock is currently held by an exclusive
/// writer.
///
/// `RwLock::try_write` operation will fail if the lock is held by any reader or by an exclusive
/// writer.
#[derive(Debug, Error)]
#[error("this operation would block.")]
pub struct TryLockError(PhantomData<()>);

impl TryLockError {
    pub(super) fn new() -> Self {
        Self(PhantomData)
    }
}

/// A type alias for the result of a nonblocking locking method.
pub type TryLockResult<T> = result::Result<T, TryLockError>;