lup 0.3.0

A custom indexed loop macro library for Rust.
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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115

use std::ops::{Neg, Not};
use std::cmp::{PartialOrd, PartialEq};

/// Stores a secret.
///
/// A secret is a data structure that might have some evidence.
/// The evidence tells why the value has the value it has.
///
/// For example, the maximum value of a list could be stored as a secret
/// which has as evidence the index where the maximum value can be found.
///
/// The meaning of secrets is interpreted depending on context.
#[derive(Debug, Clone)]
pub struct Secret<E, T> {
    /// The evidence for the value.
    pub evidence: Option<E>,
    /// The value.
    pub value: T,
}

impl<E, T> Neg for Secret<E, T>
    where T: Neg
{
    type Output = Secret<E, T::Output>;
    fn neg(self) -> Secret<E, T::Output> {
        Secret {value: -self.value, evidence: self.evidence}
    }
}

impl<E> Not for Secret<E, bool> {
    type Output = Secret<E, bool>;
    fn not(self) -> Secret<E, bool> {
        Secret {value: !self.value, evidence: self.evidence}
    }
}

impl<E, T> Secret<E, T> {
    /// Checks if secret value is less than value.
    ///
    /// This is a method because Rust does not allow overriding
    /// the output type for comparison operators.
    pub fn lt<U>(self, other: &U) -> Secret<E, bool>
        where T: PartialOrd<U>
    {
        Secret {
            value: self.value.lt(other),
            evidence: self.evidence
        }
    }

    /// Checks if secret value is less or equal than value.
    ///
    /// This is a method because Rust does not allow overriding
    /// the output type for comparison operators.
    pub fn le<U>(self, other: &U) -> Secret<E, bool>
        where T: PartialOrd<U>
    {
        Secret {
            value: self.value.le(other),
            evidence: self.evidence
        }
    }

    /// Checks if secret value is greater than value.
    ///
    /// This is a method because Rust does not allow overriding
    /// the output type for comparison operators.
    pub fn gt<U>(self, other: &U) -> Secret<E, bool>
        where T: PartialOrd<U>
    {
        Secret {
            value: self.value.gt(other),
            evidence: self.evidence
        }
    }

    /// Checks if secret value is greater or equal than value.
    ///
    /// This is a method because Rust does not allow overriding
    /// the output type for comparison operators.
    pub fn ge<U>(self, other: &U) -> Secret<E, bool>
        where T: PartialOrd<U>
    {
        Secret {
            value: self.value.ge(other),
            evidence: self.evidence
        }
    }

    /// Checks if secret value is equal to value.
    ///
    /// This is a method because Rust does not allow overriding
    /// the output type for comparison operators.
    pub fn eq<U>(self, other: &U) -> Secret<E, bool>
        where T: PartialEq<U>
    {
        Secret {
            value: self.value.eq(other),
            evidence: self.evidence
        }
    }

    /// Checks if secret value is not equal to value.
    ///
    /// This is a method because Rust does not allow overriding
    /// the output type for comparison operators.
    pub fn ne<U>(self, other: &U) -> Secret<E, bool>
        where T: PartialEq<U>
    {
        Secret {
            value: self.value.ne(other),
            evidence: self.evidence
        }
    }
}