rstmt-core 0.1.0

the core modules for the rstmt framework
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

/*
    appellation: impl_octave <module>
    authors: @FL03
*/
use crate::octave::Octave;

impl<T> Octave<T> {
    /// a functional constructor for [`Octave`], essentially wrapping the given value
    pub const fn new(octave: T) -> Self {
        Octave(octave)
    }
    /// returns a new [`Octave`] with the output of the given initializer function
    pub fn create<F>(f: F) -> Self
    where
        F: FnOnce() -> T,
    {
        Octave(f())
    }
    /// returns a new Octave with the value of one
    pub fn one() -> Self
    where
        T: num_traits::One,
    {
        Octave::create(T::one)
    }
    /// returns a new Octave with the value of zero
    pub fn zero() -> Self
    where
        T: num_traits::Zero,
    {
        Octave::create(T::zero)
    }
    /// returns a pointer to the inner value
    pub const fn as_ptr(&self) -> *const T {
        core::ptr::from_ref(&self.0)
    }
    /// returns a mutable pointer to the inner value
    pub const fn as_mut_ptr(&mut self) -> *mut T {
        core::ptr::from_mut(&mut self.0)
    }
    #[inline]
    /// consumes the index returning the inner value
    pub fn value(self) -> T {
        self.0
    }
    /// returns an immutable reference to the inner value
    pub const fn get(&self) -> &T {
        &self.0
    }
    /// returns a mutable reference to the inner value
    pub const fn get_mut(&mut self) -> &mut T {
        &mut self.0
    }
    /// apply a function to the inner value and returns a new Octave wrapping the result
    pub fn map<U, F>(self, f: F) -> Octave<U>
    where
        F: FnOnce(T) -> U,
    {
        Octave(f(self.0))
    }
    /// replaces the inner value with the given one and returns the old value
    pub const fn replace(&mut self, index: T) -> T {
        core::mem::replace(self.get_mut(), index)
    }
    /// set the index to the given value
    pub fn set(&mut self, index: T) -> &mut Self {
        *self.get_mut() = index;
        self
    }
    /// swap the values of two indices
    pub const fn swap(&mut self, other: &mut Self) {
        core::mem::swap(self.get_mut(), other.get_mut());
    }
    /// consumes the current instance to create another with the given value
    pub fn with<U>(self, other: U) -> Octave<U> {
        Octave(other)
    }
    /// takes and returns the inner value, replacing it with the logical [`default`](Default)
    /// of the type `T`
    pub fn take(&mut self) -> T
    where
        T: Default,
    {
        core::mem::take(self.get_mut())
    }
    /// returns a new instance containing a reference to the inner value
    pub const fn view(&self) -> Octave<&T> {
        Octave(self.get())
    }
    /// returns a new instance containing a mutable reference to the inner value
    pub fn view_mut(&mut self) -> Octave<&mut T> {
        Octave(self.get_mut())
    }
}