devela/sys/mem/size/
byte.rs

Help
1// devela::sys::mem::size::byte
2//
3//! Functionality related to byte sizes.
4//
5
6use crate::Ptr;
7
8impl<T> ByteSized for T {}
9
10/// Type size information in bytes.
11///
12/// This trait is automatically implemented for every `Sized` type.
13// (this allows to have associated constants depending on Self)
14pub trait ByteSized: Sized {
15    /// The alignment of this type in bytes.
16    const BYTE_ALIGN: usize = align_of::<Self>();
17    /// The size of this type in bytes.
18    const BYTE_SIZE: usize = size_of::<Self>();
19
20    /// Returns the alignment of this type in bytes.
21    fn byte_align(&self) -> usize {
22        align_of_val(self)
23    }
24
25    /// Returns the size of this type in bytes.
26    ///
27    /// Ignores any allocated resources in the heap.
28    fn byte_size(&self) -> usize {
29        size_of_val(self)
30    }
31
32    /// Returns the size ratio between [`Ptr::BYTES`]
33    /// and [`BYTE_SIZE`][Self#associatedconstant.BYTE_SIZE].
34    ///
35    /// For example: the ratio will be (1, 1) if both sizes are the same,
36    /// (2, 1) if a pointer is double the byte size, and (1, 2) if a pointer is
37    /// half the byte size.
38    ///
39    /// # Example
40    /// ```
41    /// use devela::ByteSized;
42    ///
43    /// assert_eq![().ptr_size_ratio(), [1, 0]];
44    /// assert_eq![1_usize.ptr_size_ratio(), [1, 1]];
45    /// assert_eq!["slice".ptr_size_ratio(), [1, 2]];
46    /// assert_eq![String::from("hello").ptr_size_ratio(), [1, 3]];
47    ///
48    /// #[cfg(target_pointer_width = "64")]
49    /// {
50    ///     assert_eq![0_u8.ptr_size_ratio(), [8, 1]];
51    ///     assert_eq![0_u16.ptr_size_ratio(), [4, 1]];
52    ///     assert_eq![0_u32.ptr_size_ratio(), [2, 1]];
53    ///     assert_eq![0_u64.ptr_size_ratio(), [1, 1]];
54    ///     assert_eq![0_u128.ptr_size_ratio(), [1, 2]];
55    ///     assert_eq!['c'.ptr_size_ratio(), [2, 1]];
56    ///     assert_eq!["slice".ptr_size_ratio(), [1, 2]];
57    /// }
58    /// ```
59    ///
60    /// For the `const` version see [`Ptr::size_ratio`].
61    fn ptr_size_ratio(&self) -> [usize; 2] {
62        Ptr::size_ratio(Self::BYTE_SIZE)
63    }
64}
devela/sys/mem/size/byte.rs

devela/sys/mem/size/
byte.rs
