module-lattice 0.2.3

Functionality shared between the `ml-kem` and `ml-dsa` crates, including linear algebra with degree-256 polynomials over a prime-order field, vectors of such polynomials, and NTT polynomials and vectors, as well as packing of polynomials into coefficients with a specified number of bits
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

use core::ops::{Deref, DerefMut};

/// `Box`-like type providing opportunistic heap allocation when the `alloc` feature is available
/// that falls back to stack allocation when it's unavailable.
#[derive(Clone, Debug, PartialEq)]
pub struct MaybeBox<T> {
    #[cfg(not(feature = "alloc"))]
    inner: T,
    #[cfg(feature = "alloc")]
    inner: alloc::boxed::Box<T>,
}

impl<T> MaybeBox<T> {
    /// Create a new `MaybeBox`, using `Box` if `alloc` is available.
    #[inline]
    pub fn new(inner: T) -> Self {
        #[cfg(not(feature = "alloc"))]
        {
            Self { inner }
        }
        #[cfg(feature = "alloc")]
        Self {
            inner: alloc::boxed::Box::new(inner),
        }
    }

    /// Move the contents out of a [`MaybeBox`].
    ///
    /// This emulates the compiler magic that allows moving out of a box with `*my_box`.
    #[inline]
    #[must_use]
    pub fn into_inner(self) -> T {
        #[cfg(not(feature = "alloc"))]
        {
            self.inner
        }
        #[cfg(feature = "alloc")]
        {
            *self.inner
        }
    }
}

impl<T> Deref for MaybeBox<T> {
    type Target = T;

    fn deref(&self) -> &Self::Target {
        &self.inner
    }
}

impl<T> DerefMut for MaybeBox<T> {
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.inner
    }
}