devela 0.29.0

A development substrate of coherence.
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

// devela/src/run/permission.rs
//
//! Defines [`PermissionState`], [`PermissionError`].
//

use crate::AsyncPoll;

#[doc = crate::_tags!(error runtime)]
/// An error while determining or changing a permission state.
#[doc = crate::_doc_meta!{
    location("run/permission", enum PermissionError),
    test_size_of(PermissionError = 1|8; niche Option),
}]
#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)]
pub enum PermissionError {
    /// The permission or requested permission operation is unsupported.
    Unsupported,

    /// The permission operation could not be completed.
    Failed,
}
crate::impl_trait![fmt::Display+Error for PermissionError |self, f| match *self {
    Self::Unsupported => f.write_str(""),
    Self::Failed => f.write_str(""),
}];

#[doc = crate::_tags!(runtime result)]
/// The result of polling a non-blocking permission query.
#[doc = crate::_doc_meta!{
    location("run/permission", type PermissionQuery),
    test_size_of(PermissionQuery = 2|16; niche Option),
}]
/// - [`Pending`][AsyncPoll::Pending] means that no result is available yet.
/// - [`Ready(Ok(_))`][AsyncPoll::Ready] contains the current permission state.
/// - [`Ready(Err(_))`][AsyncPoll::Ready] means the state could not be determined.
pub type PermissionQuery<E = PermissionError> = AsyncPoll<Result<PermissionState, E>>;

#[doc = crate::_tags!(runtime state)]
/// The effective authorization state of a permission.
#[doc = crate::_doc_meta!{
    location("run/permission", enum PermissionState),
    test_size_of(PermissionState = 1|8; niche Option),
}]
#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)]
pub enum PermissionState {
    /// The protected operation is currently authorized.
    Granted,

    /// Authorization remains undecided or requestable.
    ///
    /// Requesting the permission may require interaction with the user,
    /// a policy provider, or another authorizing authority.
    Prompt,

    /// The protected operation is currently not authorized.
    Denied,
}
crate::_impl_init![Self::Prompt => PermissionState];