facet-core 0.46.0

Core reflection traits and types for the facet ecosystem - provides the Facet trait, Shape metadata, and type-erased pointers
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

use core::ptr::NonNull;

use crate::{
    Def, Facet, HashProxy, KnownPointer, OxPtrConst, PointerDef, PointerFlags, PointerVTable,
    PtrConst, PtrMut, PtrUninit, Shape, ShapeBuilder, Type, TypeParam, UserType, VTableIndirect,
};

// Debug for NonNull<T> - just prints the pointer value
unsafe fn nonnull_debug(
    ox: OxPtrConst,
    f: &mut core::fmt::Formatter<'_>,
) -> Option<core::fmt::Result> {
    let ptr = ox.ptr();
    // Read the NonNull<T> which is just a pointer
    let inner_ptr = unsafe { *(ptr.as_byte_ptr() as *const *const u8) };
    Some(write!(f, "{inner_ptr:p}"))
}

// Hash for NonNull<T> - hash the pointer value
unsafe fn nonnull_hash(ox: OxPtrConst, hasher: &mut HashProxy<'_>) -> Option<()> {
    use core::hash::Hasher;
    let ptr = ox.ptr();
    let inner_ptr = unsafe { *(ptr.as_byte_ptr() as *const *const u8) };
    hasher.write_usize(inner_ptr as usize);
    Some(())
}

// PartialEq for NonNull<T> - compare pointer values
unsafe fn nonnull_partial_eq(a: OxPtrConst, b: OxPtrConst) -> Option<bool> {
    let a_ptr = a.ptr();
    let b_ptr = b.ptr();
    let a_inner = unsafe { *(a_ptr.as_byte_ptr() as *const *const u8) };
    let b_inner = unsafe { *(b_ptr.as_byte_ptr() as *const *const u8) };
    Some(a_inner == b_inner)
}

// PartialOrd for NonNull<T> - compare pointer values
unsafe fn nonnull_partial_cmp(a: OxPtrConst, b: OxPtrConst) -> Option<Option<core::cmp::Ordering>> {
    let a_ptr = a.ptr();
    let b_ptr = b.ptr();
    let a_inner = unsafe { *(a_ptr.as_byte_ptr() as *const *const u8) };
    let b_inner = unsafe { *(b_ptr.as_byte_ptr() as *const *const u8) };
    Some(a_inner.partial_cmp(&b_inner))
}

// Ord for NonNull<T> - compare pointer values
unsafe fn nonnull_cmp(a: OxPtrConst, b: OxPtrConst) -> Option<core::cmp::Ordering> {
    let a_ptr = a.ptr();
    let b_ptr = b.ptr();
    let a_inner = unsafe { *(a_ptr.as_byte_ptr() as *const *const u8) };
    let b_inner = unsafe { *(b_ptr.as_byte_ptr() as *const *const u8) };
    Some(a_inner.cmp(&b_inner))
}

// Shared vtable for all NonNull<T>
const NONNULL_VTABLE: VTableIndirect = VTableIndirect {
    display: None,
    debug: Some(nonnull_debug),
    hash: Some(nonnull_hash),
    invariants: None,
    parse: None,
    parse_bytes: None,
    try_from: None,
    try_into_inner: None,
    try_borrow_inner: None,
    partial_eq: Some(nonnull_partial_eq),
    partial_cmp: Some(nonnull_partial_cmp),
    cmp: Some(nonnull_cmp),
};

// Named function for borrow_fn
unsafe extern "C" fn borrow_fn<'a, T: Facet<'a>>(this: PtrConst) -> PtrConst {
    unsafe {
        let ptr = this.get::<NonNull<T>>();
        PtrConst::new(ptr.as_ptr())
    }
}

// Named function for new_into_fn
unsafe extern "C" fn new_into_fn<'a, 'ptr, T: Facet<'a>>(this: PtrUninit, ptr: PtrMut) -> PtrMut {
    unsafe {
        let raw_ptr = ptr.read::<*mut T>();
        let non_null = core::ptr::NonNull::new_unchecked(raw_ptr);
        this.put(non_null)
    }
}

unsafe impl<'a, T: Facet<'a>> Facet<'a> for core::ptr::NonNull<T> {
    const SHAPE: &'static Shape = &const {
        ShapeBuilder::for_sized::<Self>("NonNull")
            .module_path("core::ptr")
            .ty(Type::User(UserType::Opaque))
            .def(Def::Pointer(PointerDef {
                vtable: &const {
                    PointerVTable {
                        borrow_fn: Some(borrow_fn::<T>),
                        new_into_fn: Some(new_into_fn::<T>),
                        ..PointerVTable::new()
                    }
                },
                pointee: Some(T::SHAPE),
                weak: None,
                strong: None,
                flags: PointerFlags::EMPTY,
                known: Some(KnownPointer::NonNull),
            }))
            .type_params(&[TypeParam {
                name: "T",
                shape: T::SHAPE,
            }])
            .vtable_indirect(&NONNULL_VTABLE)
            .eq()
            .copy()
            .build()
    };
}