trident3-base 3.0.1

Foundation runtime library for Trident 3
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

/// Defines the layout of memory to be allocated.
#[derive(Copy, Clone)]
pub struct Layout {
   #[doc(hidden)]
   pub size: usize,
   #[doc(hidden)]
   pub align: usize,
}

impl Layout {
   /// Creates a new instance of a Layout.
   #[inline]
   pub fn new<T>() -> Self {
      return Layout {
         size: size_of::<T>(),
         align: align_of::<T>(),
      };
   }

   /// Creates a new instance of a Layout with the given size.
   #[inline]
   pub fn from_size(size: usize) -> Self {
      return Layout { size, align: 4 };
   }

   #[inline]
   pub fn from_size_align(size: usize, align: usize) -> Self {
      return Layout{ size, align };
   }

   /// Create a new instance of Layout from the given array-length and type parameter.
   #[inline]
   pub fn from_type_array<T>(length: usize) -> Self {
      return Layout {
         size: size_of::<T>() * length,
         align: align_of::<T>(),
      };
   }

   /// Realigns data.
   #[inline(always)]
   pub fn align_up(&self, i: usize) -> usize {
      let p = i + self.align - 1;
      return p - (p % self.align);
   }
}

impl Into<StdLayout> for Layout {
   fn into(self) -> StdLayout {
      return StdLayout::from_size_align(self.size, self.align).unwrap();
   }
}

impl From<StdLayout> for Layout {
   fn from(value: StdLayout) -> Self {
      return Layout::from_size(value.size());
   }
}

#[derive(Debug)]
pub struct LayoutError;

impl Display for LayoutError {
   fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
      write!(f, "An error occurred for the requested layout")
   }
}

// IMPORTS //

use {
   std_alloc::alloc::Layout as StdLayout,
   core::{
      fmt::{self, Display},
      mem::{align_of, size_of},
   },
};