gix_sec/
permission.rs

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
use std::fmt::{Debug, Display, Formatter};

use crate::Permission;

/// An error to use if an operation cannot proceed due to insufficient permissions.
///
/// It's up to the implementation to decide which permission is required for an operation, and which one
/// causes errors.
#[derive(Debug)]
pub struct Error<R: std::fmt::Debug> {
    /// The resource which cannot be used.
    pub resource: R,
}

impl<R> Display for Error<R>
where
    R: std::fmt::Debug,
{
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        write!(
            f,
            "Not allowed to handle resource {:?}: permission denied",
            self.resource
        )
    }
}

impl<R> std::error::Error for Error<R> where R: std::fmt::Debug {}

impl Permission {
    /// Return true if this instance is `Permission::Allow`.
    pub fn is_allowed(&self) -> bool {
        matches!(self, Permission::Allow)
    }
    /// Check this permissions and produce a reply to indicate if the `resource` can be used and in which way.
    ///
    /// Only if this permission is set to `Allow` will the resource be usable.
    pub fn check<R: std::fmt::Debug>(&self, resource: R) -> Result<Option<R>, Error<R>> {
        match self {
            Permission::Allow => Ok(Some(resource)),
            Permission::Deny => Ok(None),
            Permission::Forbid => Err(Error { resource }),
        }
    }

    /// Like [`check()`][Self::check()], but degenerates the type to an option to make it more useful in cases where
    /// `Forbid` shouldn't abort the entire operation.
    pub fn check_opt<R: std::fmt::Debug>(&self, resource: R) -> Option<R> {
        match self {
            Permission::Allow => Some(resource),
            Permission::Deny | Permission::Forbid => None,
        }
    }
}