xref 0.1.1

Like Cow, but also works with RefCell
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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120

use std::borrow::Borrow;
use std::cell::Ref;
use std::fmt;
use std::ops::Deref;

/// Kind of like Cow, but might also be a Ref (from a RefCell)
/// Also, does not use ToOwned.
/// This is because the main point of an XRef is not to Copy On Write,
/// but to either hold an owned value or a reference to a value
pub enum XRef<'a, T> {
    Borrowed(&'a T),
    Ref(Ref<'a, T>),
    Owned(T),
}

impl<'a, T> XRef<'a, T> {
    pub fn to_ref(&self) -> &T {
        match self {
            Self::Borrowed(r) => r,
            Self::Ref(r) => r,
            Self::Owned(t) => &t,
        }
    }
}

impl<'a, T: Clone> XRef<'a, T> {
    /// Acquires a mutable reference to the owned form of the data.
    /// Clones the data if it is not already owned.
    pub fn to_mut(&mut self) -> &mut T {
        match self {
            Self::Borrowed(r) => {
                *self = Self::Owned(r.clone());
                match *self {
                    Self::Borrowed(..) | Self::Ref(..) => unreachable!(),
                    Self::Owned(ref mut owned) => owned,
                }
            }
            Self::Ref(r) => {
                *self = Self::Owned(r.clone());
                match *self {
                    Self::Borrowed(..) | Self::Ref(..) => unreachable!(),
                    Self::Owned(ref mut owned) => owned,
                }
            }
            Self::Owned(ref mut t) => t,
        }
    }
    /// Extracts the owned data.
    /// Clones the data if it is not already owned.
    pub fn into_owned(self) -> T {
        match self {
            Self::Borrowed(r) => r.clone(),
            Self::Ref(r) => r.clone(),
            Self::Owned(t) => t,
        }
    }
}

impl<'a, T> AsRef<T> for XRef<'a, T> {
    fn as_ref(&self) -> &T {
        match self {
            Self::Borrowed(r) => r,
            Self::Ref(r) => r,
            Self::Owned(t) => t.borrow(),
        }
    }
}

impl<'a, T> Borrow<T> for XRef<'a, T> {
    fn borrow(&self) -> &T {
        &**self
    }
}

impl<'a, T: Clone> Clone for XRef<'a, T> {
    fn clone(&self) -> Self {
        match self {
            Self::Borrowed(r) => XRef::Borrowed(r),
            Self::Ref(r) => XRef::Ref(Ref::clone(r)),
            Self::Owned(t) => Self::Owned(t.clone()),
        }
    }
}

impl<'a, T: fmt::Debug> fmt::Debug for XRef<'a, T> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::Borrowed(r) => fmt::Debug::fmt(r, f),
            Self::Ref(r) => fmt::Debug::fmt(r, f),
            Self::Owned(t) => fmt::Debug::fmt(t, f),
        }
    }
}

impl<'a, T: fmt::Display> fmt::Display for XRef<'a, T> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::Borrowed(r) => fmt::Display::fmt(r, f),
            Self::Ref(r) => fmt::Display::fmt(r, f),
            Self::Owned(t) => fmt::Display::fmt(t, f),
        }
    }
}

impl<'a, T: Default> Default for XRef<'a, T> {
    fn default() -> Self {
        Self::Owned(Default::default())
    }
}

impl<'a, T> Deref for XRef<'a, T> {
    type Target = T;
    fn deref(&self) -> &T {
        match self {
            Self::Borrowed(r) => r,
            Self::Ref(r) => r,
            Self::Owned(t) => t.borrow(),
        }
    }
}