[go: up one dir, main page]

arc-swap 0.3.11

Atomically swappable Arc
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

use super::{Guard, Lease, RefCnt};

/// A trait describing things that can be turned into a raw pointer.
///
/// This is just an abstraction of things that can be passed to the
/// [`compare_and_swap`](struct.ArcSwapAny.html#method.compare_and_swap).
///
/// # Examples
///
/// ```
/// use std::ptr;
/// use std::sync::Arc;
///
/// use arc_swap::ArcSwapOption;
///
/// let a = Arc::new(42);
/// let shared = ArcSwapOption::from(Some(Arc::clone(&a)));
///
/// shared.compare_and_swap(&a, Some(Arc::clone(&a)));
/// shared.compare_and_swap(&None::<Arc<_>>, Some(Arc::clone(&a)));
/// shared.compare_and_swap(shared.peek(), Some(Arc::clone(&a)));
/// shared.compare_and_swap(shared.lease(), Some(Arc::clone(&a)));
/// shared.compare_and_swap(&shared.lease(), Some(Arc::clone(&a)));
/// shared.compare_and_swap(ptr::null(), Some(Arc::clone(&a)));
/// ```
pub trait AsRaw<T> {
    /// Converts the value into a raw pointer.
    ///
    /// The value is consumed, because the trait is usually implemented on references and
    /// reference-like types.
    fn as_raw(&self) -> *mut T;
}

impl<'a, T: RefCnt> AsRaw<T::Base> for &'a T {
    fn as_raw(&self) -> *mut T::Base {
        T::as_ptr(self)
    }
}

impl<'a, T: RefCnt> AsRaw<T::Base> for Guard<'a, T> {
    fn as_raw(&self) -> *mut T::Base {
        self.ptr as *mut _
    }
}

impl<'a, T: RefCnt> AsRaw<T::Base> for &'a Lease<T> {
    fn as_raw(&self) -> *mut T::Base {
        self.ptr as *mut _
    }
}

impl<T: RefCnt> AsRaw<T::Base> for Lease<T> {
    fn as_raw(&self) -> *mut T::Base {
        self.ptr as *mut _
    }
}

impl<T> AsRaw<T> for *mut T {
    fn as_raw(&self) -> *mut T {
        *self
    }
}

impl<T> AsRaw<T> for *const T {
    fn as_raw(&self) -> *mut T {
        *self as *mut T
    }
}