machine-check-machine 0.7.1

Utility crate for the formal verification tool machine-check
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158

use std::{error::Error, fmt::Display};

use vec1::Vec1;

#[derive(Debug)]
pub struct ErrorList<E: Error> {
    errors: Vec1<E>,
}

impl<E: Error> ErrorList<E> {
    pub fn into_errors(self) -> Vec1<E> {
        self.errors
    }

    pub(crate) fn single(error: E) -> Self {
        ErrorList {
            errors: Vec1::new(error),
        }
    }

    pub(crate) fn iter_to_result(iter: impl IntoIterator<Item = E>) -> Result<(), Self> {
        let mut iter = iter.into_iter();
        let Some(first_error) = iter.next() else {
            // no errors
            return Ok(());
        };
        let mut errors = Vec1::new(first_error);
        errors.extend(iter);
        Err(Self { errors })
    }

    pub(crate) fn combine<T, U>(a: Result<T, Self>, b: Result<U, Self>) -> Result<(T, U), Self> {
        match (a, b) {
            (Ok(a), Ok(b)) => Ok((a, b)),
            (Err(a), Ok(_)) => Err(a),
            (Ok(_), Err(b)) => Err(b),
            (Err(mut a), Err(b)) => {
                a.extend(b);
                Err(a)
            }
        }
    }

    pub(crate) fn combine_and_vec<T, U>(
        a: Result<T, Self>,
        b: Result<U, Self>,
        errors: Vec<E>,
    ) -> Result<(T, U), Self> {
        let (a, b) = match Self::combine(a, b) {
            Ok(ok) => ok,
            Err(mut err) => {
                err.extend(errors);
                return Err(err);
            }
        };
        Self::iter_to_result(errors)?;
        Ok((a, b))
    }

    pub(crate) fn errors_vec_to_result(errors: Vec<Self>) -> Result<(), Self> {
        if errors.is_empty() {
            return Ok(());
        }

        let mut errors_iter = errors.into_iter();

        let Some(first_errors) = errors_iter.next() else {
            // no errors
            return Ok(());
        };

        let mut result = first_errors;
        for errors in errors_iter {
            result.extend(errors);
        }
        Err(result)
    }

    pub(crate) fn vec_result<T>(vec: Vec<Result<T, E>>) -> Result<Vec<T>, Self> {
        let mut ok_result = Vec::new();
        let mut err_result = Vec::new();
        for element in vec {
            match element {
                Ok(ok) => ok_result.push(ok),
                Err(err) => err_result.push(err),
            }
        }
        Self::iter_to_result(err_result).map(|_| ok_result)
    }

    pub(crate) fn flat_single_result<T>(vec: Vec<Result<T, E>>) -> Result<Vec<T>, Self> {
        let vec = vec
            .into_iter()
            .map(|element| element.map_err(|err| Self::single(err)))
            .collect();
        Self::flat_result(vec)
    }

    pub(crate) fn flat_result<T>(vec: Vec<Result<T, Self>>) -> Result<Vec<T>, Self> {
        let mut ok_result = Vec::new();
        let mut err_result = Vec::new();
        for element in vec {
            match element {
                Ok(ok) => ok_result.push(ok),
                Err(err) => err_result.extend(err.into_iter()),
            }
        }
        Self::iter_to_result(err_result).map(|_| ok_result)
    }

    pub(crate) fn convert_inner<F: Error>(self) -> ErrorList<F>
    where
        E: std::convert::Into<F>,
    {
        ErrorList::<F> {
            errors: self.errors.mapped(Into::into),
        }
    }
}

impl<E: Error> From<E> for ErrorList<E> {
    fn from(error: E) -> Self {
        ErrorList::single(error)
    }
}

impl<E: Error> IntoIterator for ErrorList<E> {
    type Item = E;

    type IntoIter = <Vec1<E> as IntoIterator>::IntoIter;

    fn into_iter(self) -> Self::IntoIter {
        self.errors.into_iter()
    }
}

impl<E: Error> Extend<E> for ErrorList<E> {
    fn extend<T: IntoIterator<Item = E>>(&mut self, iter: T) {
        self.errors.extend(iter);
    }
}

impl<E: Error> Extend<ErrorList<E>> for ErrorList<E> {
    fn extend<T: IntoIterator<Item = ErrorList<E>>>(&mut self, iter: T) {
        for errors in iter {
            self.errors.extend(errors);
        }
    }
}

impl<E: Error> Display for ErrorList<E> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        for error in &self.errors {
            writeln!(f, "{}", error)?;
        }
        Ok(())
    }
}