devela/code/result/
value_quant.rs

Help
1// devela::code::result::value_quant
2//
3//! Defines [`ValueQuant`].
4//
5
6#[doc = crate::TAG_RESULT!()]
7/// A value with associated quantification.
8#[must_use]
9pub struct ValueQuant<V, Q> {
10    /// The main value.
11    pub v: V,
12    /// The quantification of the value.
13    pub q: Q,
14}
15
16impl<V, Q> ValueQuant<V, Q> {
17    /// A constructor with the given `value` and `quant`.
18    pub const fn new(value: V, quant: Q) -> ValueQuant<V, Q> {
19        ValueQuant { v: value, q: quant }
20    }
21
22    /// Constructs itself from a tuple.
23    #[rustfmt::skip]
24    pub fn from_vq(tuple: (V, Q)) -> ValueQuant<V, Q> {
25        ValueQuant { v: tuple.0, q: tuple.1, }
26    }
27
28    /// Transforms itself into a tuple.
29    #[must_use] #[rustfmt::skip]
30    pub fn vq(self) -> (V, Q) { (self.v, self.q) }
31
32    /// Returns a tuple of shared references to its fields.
33    #[must_use] #[rustfmt::skip]
34    pub const fn vq_ref(&self) -> (&V, &Q) { (&self.v, &self.q) }
35
36    /// Returns a tuple of exclusive references to its fields.
37    #[must_use] #[rustfmt::skip]
38    pub const fn vq_mut(&mut self) -> (&mut V, &mut Q) { (&mut self.v, &mut self.q) }
39}
40
41impl<V: Copy, Q: Copy> ValueQuant<V, Q> {
42    /// Constructs itself from a tuple, in compile-time.
43    #[rustfmt::skip]
44    pub const fn from_vq_const(tuple: (V, Q)) -> ValueQuant<V, Q> {
45        ValueQuant { v: tuple.0, q: tuple.1,
46        }
47    }
48
49    /// Transforms itself into a tuple, in compile-time.
50    #[must_use] #[rustfmt::skip]
51    pub const fn vq_const(self) -> (V, Q) { (self.v, self.q) }
52}
53
54mod core_impls {
55    use crate::{impl_trait, Ordering, ValueQuant};
56
57    impl<V: Clone, Q: Clone> Clone for ValueQuant<V, Q> {
58        fn clone(&self) -> Self {
59            Self { v: self.v.clone(), q: self.q.clone() }
60        }
61    }
62    impl<V: Copy, Q: Copy> Copy for ValueQuant<V, Q> {}
63
64    impl<V: Default, Q: Default> Default for ValueQuant<V, Q> {
65        /// Returns an empty ValueQuant with `None` for both fields.
66        fn default() -> Self {
67            Self { v: Default::default(), q: Default::default() }
68        }
69    }
70
71    impl_trait! { fmt::Debug for ValueQuant<V, Q> where V, Q |self, f|
72       f.debug_struct("ValueQuant").field("v", &self.v).field("q", &self.q).finish()
73    }
74    impl_trait! { fmt::Display for ValueQuant<V, Q> where V, Q |self, f|
75        write!(f, "Value: {}, Quant: {}", self.v, self.q)
76    }
77
78    impl<V: PartialEq, Q: PartialEq> PartialEq for ValueQuant<V, Q> {
79        fn eq(&self, other: &Self) -> bool {
80            self.v == other.v && self.q == other.q
81        }
82    }
83    impl<V: Eq, Q: Eq> Eq for ValueQuant<V, Q> {}
84    // with a tuple:
85    impl<V: PartialEq, Q: PartialEq> PartialEq<(V, Q)> for ValueQuant<V, Q> {
86        fn eq(&self, other: &(V, Q)) -> bool {
87            self.v == other.0 && self.q == other.1
88        }
89    }
90
91    impl<V: PartialOrd, Q: PartialOrd> PartialOrd for ValueQuant<V, Q> {
92        /// Compare `value` first. If they are equal, then compare `quant`.
93        fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
94            match self.v.partial_cmp(&other.v) {
95                Some(Ordering::Equal) => self.q.partial_cmp(&other.q),
96                other => other,
97            }
98        }
99    }
100    impl<V: Ord, Q: Ord> Ord for ValueQuant<V, Q> {
101        /// Compare `value` first. If they are equal, then compare `quant`.
102        fn cmp(&self, other: &Self) -> Ordering {
103            match self.v.cmp(&other.v) {
104                Ordering::Equal => self.q.cmp(&other.q),
105                order => order,
106            }
107        }
108    }
109    impl_trait! { Hash for ValueQuant<V, Q> where V, Q |self, state|
110        { self.v.hash(state); self.q.hash(state); }
111    }
112}
devela/code/result/value_quant.rs

devela/code/result/
value_quant.rs
