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

#[derive(Debug, Clone, Copy, Ord, PartialOrd, Eq, PartialEq, Hash)]
/// [`ReadApi`](crate::ReadApi) wrapper for constant references.
///
/// # Example
///
/// ```rust
/// use read_write_api::{ReadApi, ReadApiWrapper};
/// use parking_lot::RwLock;
///
/// fn read<T: ReadApi>(x: &T) -> T::ReadGuard<'_> {
///     x.read()
/// }
///
/// let _ = read(&ReadApiWrapper(&1));
/// let _ = read(&RwLock::new(2));
/// ```
pub struct ReadApiWrapper<'a, T>(
    /// Wrapped reference.
    pub &'a T
);

#[derive(Debug, Ord, PartialOrd, Eq, PartialEq, Hash)]
/// [`RwApi`](crate::RwApi) wrapper for mutable references.
///
/// # Example
///
/// See the [`RwApi`](crate::RwApi) docs for usage examples.
pub struct RwApiWrapper<'a, T>(
    /// Wrapped reference.
    pub &'a mut T
);

#[derive(Default, Debug, Clone, Copy, Ord, PartialOrd, Eq, PartialEq, Hash)]
/// [`RwApi`](crate::RwApi) owning wrapper for solitary objects.
///
/// # Example
///
/// See the [`RwApi`](crate::RwApi) docs for usage examples.
pub struct RwApiWrapperOwned<T>(
    /// Wrapped owned object.
    pub T
);