passdata 0.0.2

Authentication and authorization data in a logic programming language.
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
159
160
161
162
163
164
165
166
167

//! Error type for the crate.

use core::{
    fmt::{self, Display},
    result,
};

#[cfg(all(feature = "alloc", not(feature = "std")))]
use alloc::boxed::Box;
#[cfg(feature = "std")]
use std::{boxed::Box, error};

use crate::{facts::FactTermsError, utils::QueryResultError};

/// Alias for a [`Result`][result::Result] with an [Error] error type.
pub type Result<T> = result::Result<T, Error>;

/// Errors when evaluating a query.
#[derive(PartialEq)]
pub struct Error {
    inner: Box<ErrorImpl>,
}

impl Error {
    /// Constructs an error with the kind.
    #[must_use]
    #[inline]
    fn new(kind: ErrorKind) -> Self {
        Self {
            inner: Box::new(ErrorImpl { kind }),
        }
    }

    #[must_use]
    #[inline]
    pub(crate) fn with_kind(kind: ErrorKind) -> Self {
        Self::new(kind)
    }

    #[cfg(test)]
    #[must_use]
    #[inline]
    pub(crate) fn is_schema_error(&self) -> bool {
        match self.inner.kind {
            ErrorKind::QueryResultError(_)
            | ErrorKind::MultipleMatchingFacts
            | ErrorKind::DuplicateSchema
            | ErrorKind::FactTermsError(_)
            | ErrorKind::InvalidContextValue
            | ErrorKind::ContextFull => false,
            ErrorKind::UnknownPredicate | ErrorKind::MismatchSchemaTys => true,
        }
    }
}

impl Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        Display::fmt(&self.inner, f)
    }
}

impl fmt::Debug for Error {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        fmt::Debug::fmt(&self.inner, f)
    }
}

impl From<QueryResultError> for Error {
    fn from(value: QueryResultError) -> Self {
        Self::with_kind(ErrorKind::QueryResultError(value))
    }
}

impl From<FactTermsError> for Error {
    fn from(value: FactTermsError) -> Self {
        Self::with_kind(ErrorKind::FactTermsError(value))
    }
}

#[derive(PartialEq)]
struct ErrorImpl {
    kind: ErrorKind,
}

impl Display for ErrorImpl {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        Display::fmt(&self.kind, f)
    }
}

impl fmt::Debug for ErrorImpl {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("Error").field("kind", &self.kind).finish()
    }
}

/// All possible crate errors.
#[allow(clippy::module_name_repetitions)]
#[derive(PartialEq)]
pub(crate) enum ErrorKind {
    /// Query result error
    QueryResultError(QueryResultError),
    /// If there are multiple matching facts
    MultipleMatchingFacts,
    /// If a schema has already been added for a predicate
    DuplicateSchema,
    /// If a predicate is not in the schema
    UnknownPredicate,
    /// The given types do not match the schema
    MismatchSchemaTys,
    /// Fact terms error
    FactTermsError(FactTermsError),
    /// The value cannot be added to the context
    InvalidContextValue,
    /// The context cannot add any more data
    ContextFull,
}

#[cfg(feature = "std")]
impl error::Error for ErrorKind {
    fn source(&self) -> Option<&(dyn error::Error + 'static)> {
        match self {
            ErrorKind::MultipleMatchingFacts
            | ErrorKind::DuplicateSchema
            | ErrorKind::UnknownPredicate
            | ErrorKind::MismatchSchemaTys
            | ErrorKind::InvalidContextValue
            | ErrorKind::ContextFull => None,
            ErrorKind::QueryResultError(e) => Some(e),
            ErrorKind::FactTermsError(e) => Some(e),
        }
    }
}

impl Display for ErrorKind {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            ErrorKind::MultipleMatchingFacts => f.write_str("should be a single matching fact"),
            ErrorKind::QueryResultError(e) => Display::fmt(e, f),
            ErrorKind::DuplicateSchema => {
                f.write_str("schema for predicate should only be added once")
            }
            ErrorKind::UnknownPredicate => f.write_str("predicate should be in the schema"),
            ErrorKind::MismatchSchemaTys => f.write_str("types should match schema"),
            ErrorKind::FactTermsError(e) => Display::fmt(e, f),
            ErrorKind::InvalidContextValue => f.write_str("value cannot be added to context"),
            ErrorKind::ContextFull => f.write_str("context cannot add more data"),
        }
    }
}

impl fmt::Debug for ErrorKind {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            ErrorKind::MultipleMatchingFacts => f.write_str("should be a single matching fact"),
            ErrorKind::QueryResultError(e) => fmt::Debug::fmt(e, f),
            ErrorKind::DuplicateSchema => {
                f.write_str("schema for predicate should only be added once")
            }
            ErrorKind::UnknownPredicate => f.write_str("predicate should be in the schema"),
            ErrorKind::MismatchSchemaTys => f.write_str("types should match schema"),
            ErrorKind::FactTermsError(e) => fmt::Debug::fmt(e, f),
            ErrorKind::InvalidContextValue => f.write_str("value cannot be added to context"),
            ErrorKind::ContextFull => f.write_str("context cannot add more data"),
        }
    }
}