atomic-primitive 0.1.3

Traits for primitive atomic types
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
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

#![doc = include_str!("../README.md")]
#![no_std]

#[macro_use]
mod macros;

mod atomic;
mod integer;
mod signed;
mod unsigned;

#[cfg(test)]
mod tests;

pub use self::atomic::PrimitiveAtomic;
pub use self::integer::PrimitiveAtomicInteger;
pub use self::signed::PrimitiveAtomicSigned;
pub use self::unsigned::PrimitiveAtomicUnsigned;

trait Sealed {}

/// Maps a non-atomic primitive type to its corresponding atomic type.
///
/// This mirrors the unstable [`core::sync::atomic::AtomicPrimitive`] trait.
/// Once that trait is stabilized, this can be deprecated in favor of the std
/// version.
///
/// # Examples
///
/// ```
/// use atomic_primitive::{AtomicPrimitive, PrimitiveAtomic};
///
/// fn make_atomic<T: AtomicPrimitive>(val: T) -> T::Atomic {
///     T::Atomic::new(val)
/// }
/// ```
///
/// [`core::sync::atomic::AtomicPrimitive`]: https://doc.rust-lang.org/core/sync/atomic/trait.AtomicPrimitive.html
pub trait AtomicPrimitive: Sized + Copy + Send + Sync {
    /// The atomic type corresponding to this primitive type.
    ///
    /// Note that the bound on `Value` is not imposed in the unstable
    /// `core::sync::atomic::AtomicPrimitive` trait, but it is useful
    /// to round-trip between the primitive and atomic types.
    type Atomic: PrimitiveAtomic<Value = Self>;

    /// Converts this value to its atomic counterpart.
    #[inline]
    fn to_atomic(self) -> Self::Atomic {
        Self::Atomic::new(self)
    }
}

/// Type alias for the atomic version of a primitive type.
///
/// This mirrors the unstable [`core::sync::atomic::Atomic`] type alias.
///
/// [`core::sync::atomic::Atomic`]: https://doc.rust-lang.org/core/sync/atomic/type.Atomic.html
pub type Atomic<T> = <T as AtomicPrimitive>::Atomic;

macro_rules! impl_atomic_primitive {
    ($($Primitive:ty => $AtomicType:ty),+ $(,)?) => {$(
        impl AtomicPrimitive for $Primitive {
            type Atomic = $AtomicType;
        }
    )+};
}

use core::sync::atomic::{
    AtomicBool, AtomicI8, AtomicI16, AtomicI32, AtomicIsize, AtomicU8, AtomicU16, AtomicU32,
    AtomicUsize,
};
#[cfg(target_has_atomic = "64")]
use core::sync::atomic::{AtomicI64, AtomicU64};

impl_atomic_primitive! {
    bool => AtomicBool,
    u8 => AtomicU8,
    u16 => AtomicU16,
    u32 => AtomicU32,
    usize => AtomicUsize,
    i8 => AtomicI8,
    i16 => AtomicI16,
    i32 => AtomicI32,
    isize => AtomicIsize,
}

#[cfg(target_has_atomic = "64")]
impl_atomic_primitive! {
    u64 => AtomicU64,
    i64 => AtomicI64,
}