bittern 1.0.1

A reference-counted arena for interning and deduplicating data
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

use crate::Arena;

/// Trait for references to an item in an arena.
pub trait AnyRef<T: ?Sized> {
    /// Gets the underlying raw pointer of a reference
    fn as_ptr(&self) -> *const T;

    /// Returns `true` if this item is allocated in the specified arena.
    fn owned_by(&self, arena: &Arena<T>) -> bool;

    /// Returns `true` if two references point to the same item, using a pointer equality check.
    ///
    /// Equivalent to [`PartialEq::eq`], but `is` may be preferred for semantic clarity.
    #[inline]
    fn is<O: AnyRef<T>>(&self, other: &O) -> bool {
        core::ptr::eq(self.as_ptr(), other.as_ptr())
    }

    /// Returns `true` if two references point to different items, using a pointer equality check.
    /// Equivalent to `!self.is(other)`.
    ///
    /// Equivalent to [`PartialEq::ne`], but `is_not` may be preferred for semantic clarity.
    #[inline]
    fn is_not<O: AnyRef<T>>(&self, other: &O) -> bool {
        !self.is(other)
    }
}


macro_rules! inherent_ref_methods {
    (<$T:ident>) => {
        /// Returns `true` if two references point to the same item, using a pointer equality check.
        ///
        /// Equivalent to [`PartialEq::eq`], but `is` may be preferred for semantic clarity.
        #[inline]
        pub fn is<O: crate::AnyRef<$T>>(&self, other: &O) -> bool {
            crate::AnyRef::is(self, other)
        }

        /// Returns `true` if two references point to different items, using a pointer equality check.
        /// Equivalent to `!self.is(other)`.
        ///
        /// Equivalent to [`PartialEq::ne`], but `is_not` may be preferred for semantic clarity.
        #[inline]
        pub fn is_not<O: crate::AnyRef<$T>>(&self, other: &O) -> bool {
            crate::AnyRef::is_not(self, other)
        }
    };
}
pub(crate) use inherent_ref_methods;