libutils-pointer 0.0.0

A typed custom pointer to 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
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
121
122
123
124
125
126

//^
//^ HEAD
//^

//> HEAD -> NO_STD
#![no_std]

//> HEAD -> FEATURES
#![feature(const_destruct)]
#![feature(const_option_ops)]
#![feature(const_trait_impl)]
#![feature(const_closures)]
#![feature(const_try)]
#![feature(const_default)]
#![feature(const_convert)]
#![feature(ptr_mask)]

//> HEAD -> MODULES
mod comparisons;
mod conversions;
#[cfg(test)]
mod tests;

//> HEAD -> CORE
use core::{
    ptr::{
        NonNull,
        null,
        null_mut
    },
    fmt::{
        Debug,
        Formatter,
        Result as Format
    },
    any::type_name,
    marker::Destruct
};


//^
//^ POINTER
//^

//> POINTER -> STRUCT
pub struct Pointer<Type> {
    to: Option<NonNull<Type>>
}

//> POINTER -> IMPLEMENTATION
impl<Type> Pointer<Type> {
    #[inline]
    pub const fn is_null(self) -> bool {return self.to.is_none()}
    #[inline]
    pub fn address(self) -> usize {return self.to.map(|pointer| pointer.addr().into()).unwrap_or_default()}
    #[inline]
    pub const fn add(self, count: usize) -> Pointer<Type> {return Self {
        to: self.to.map(const |pointer| unsafe {pointer.add(count)})
    }}
    #[inline]
    pub const fn sub(self, count: usize) -> Pointer<Type> {return Self {
        to: self.to.map(const |pointer| unsafe {pointer.sub(count)})
    }}
    #[inline]
    pub const unsafe fn read(self) -> Option<Type> {return Some(unsafe {self.to?.read()})}
    #[inline]
    pub const fn as_ptr(self) -> *const Type {return match self.to {
        None => null(),
        Some(pointer) => pointer.as_ptr()
    }}
    #[inline]
    pub const fn as_ptr_mut(self) -> *mut Type {return match self.to {
        None => null_mut(),
        Some(pointer) => pointer.as_ptr()
    }}
    #[inline]
    pub const fn get<'lifetime>(self) -> Option<&'lifetime Type> {return self.to.map(const |pointer| unsafe {pointer.as_ref()})}
    #[inline]
    pub const fn get_mut<'lifetime>(self) -> Option<&'lifetime mut Type> {return self.to.map(const |mut pointer| unsafe {pointer.as_mut()})}
    #[inline]
    pub const fn take(self) -> Option<NonNull<Type>> {return self.to}
    #[inline]
    pub fn is_aligned(self) -> bool {return self.address() % align_of::<Type>() == 0}
    #[inline]
    pub const fn cast<Other>(self) -> Pointer<Other> {return Pointer {
        to: self.to.map(const |pointer| pointer.cast())
    }}
    #[inline]
    pub fn mask(self, mask: usize) -> Pointer<Type> {Pointer::from(self.to.map(|pointer| pointer.as_ptr()).unwrap_or(null_mut()).mask(mask))}
}

//> POINTER -> IMPLEMENTATION WITH DESTRUCT
const impl<Type: [const] Destruct> Pointer<Type> {
    #[inline]
    pub unsafe fn write(self, value: Type) -> () {if let Some(pointer) = self.to {unsafe {pointer.write(value)}}}
    #[inline]
    pub unsafe fn replace(self, with: Type) -> Option<Type> {return Some(unsafe {self.to?.replace(with)})}
}

//> POINTER -> CLONE
impl<Type> Clone for Pointer<Type> {
    fn clone(&self) -> Self {return Self {
        to: self.to.clone()
    }}
}

//> POINTER -> COPY
impl<Type> Copy for Pointer<Type> {}

//> POINTER -> DEBUG
impl<Type: Debug> Debug for Pointer<Type> {
    fn fmt(&self, formatter: &mut Formatter<'_>) -> Format {write!(formatter, "*{}", type_name::<Type>())}
}

//> POINTER -> DEFAULT
const impl<Type> Default for Pointer<Type> {
    fn default() -> Self {return Self {
        to: None
    }}
}

//> POINTER -> SEND
unsafe impl<Type> Send for Pointer<Type> {}

//> POINTER -> SYNC
unsafe impl<Type> Sync for Pointer<Type> {}