shine-core 2.1.0

Reusable lifecycle runtime and domain core for Shine applications
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

//! The bounded capability supplied to AI-facing adapters.

use super::{
    CapabilityKindV1, FrontendDiagnosticV1, FrontendService, InspectionReportV1, InventoryReportV1,
    InventoryRequest, OperationStateReportV1, PlanReviewReportV1, ReviewRequest,
};
use crate::runtime::{
    FileSystemHost, FileSystemObservationHost, PrivilegedFileSystemHost, ProcessHost, SplitDnsHost,
    SplitDnsObservationHost,
};

/// No runtime accessor, generator evaluation, approval constructor or execution method.
///
/// ```compile_fail,E0599
/// use shine_core::{frontend::ReadOnlyFrontend, runtime::InMemoryHost};
/// fn cannot_get_runtime(view: ReadOnlyFrontend<'_, InMemoryHost>) {
///     view.runtime();
/// }
/// ```
///
/// ```compile_fail,E0599
/// use shine_core::{frontend::ReadOnlyFrontend, runtime::InMemoryHost};
/// fn cannot_gain_approval_authority(view: ReadOnlyFrontend<'_, InMemoryHost>) {
///     view.into_trusted();
/// }
/// ```
///
/// ```compile_fail,E0599
/// use shine_core::{frontend::{ReadOnlyFrontend, ApprovedOperation}, runtime::InMemoryHost};
/// fn cannot_apply(view: ReadOnlyFrontend<'_, InMemoryHost>, approved: ApprovedOperation) {
///     view.apply(approved);
/// }
/// ```
pub struct ReadOnlyFrontend<'a, H> {
    service: &'a FrontendService<H>,
}

impl<H> FrontendService<H> {
    pub fn read_only(&self) -> ReadOnlyFrontend<'_, H> {
        ReadOnlyFrontend { service: self }
    }
}

impl<H: FileSystemObservationHost> ReadOnlyFrontend<'_, H> {
    pub async fn inventory(
        &self,
        request: InventoryRequest,
    ) -> Result<InventoryReportV1, FrontendDiagnosticV1> {
        self.service
            .inventory(request)
            .await
            .map_err(|error| error.diagnostic().clone())
    }
}

impl<H: FileSystemObservationHost + SplitDnsObservationHost> ReadOnlyFrontend<'_, H> {
    pub async fn request_review(
        &self,
        request: &ReviewRequest,
    ) -> Result<PlanReviewReportV1, FrontendDiagnosticV1> {
        self.service
            .review(request)
            .await
            .map_err(|error| error.diagnostic().clone())
    }
    pub async fn operation_state(
        &self,
        kind: CapabilityKindV1,
    ) -> Result<OperationStateReportV1, FrontendDiagnosticV1> {
        self.service
            .operation_state(kind)
            .await
            .map_err(|error| error.diagnostic().clone())
    }
}

impl<H: FileSystemHost + PrivilegedFileSystemHost + ProcessHost> ReadOnlyFrontend<'_, H> {
    pub async fn inspect_apps(
        &self,
        categories: Vec<String>,
    ) -> Result<InspectionReportV1, FrontendDiagnosticV1> {
        self.service
            .inspect_apps(categories)
            .await
            .map(|inspection| inspection.report)
            .map_err(|error| error.diagnostic().clone())
    }
}

impl<H: FileSystemHost + PrivilegedFileSystemHost> ReadOnlyFrontend<'_, H> {
    pub async fn inspect_shells(&self) -> Result<InspectionReportV1, FrontendDiagnosticV1> {
        self.service
            .inspect_shells()
            .await
            .map(|inspection| inspection.report)
            .map_err(|error| error.diagnostic().clone())
    }
}

impl<H: FileSystemHost + PrivilegedFileSystemHost + SplitDnsHost> ReadOnlyFrontend<'_, H> {
    pub async fn inspect_sys(
        &self,
        os_id: &str,
    ) -> Result<InspectionReportV1, FrontendDiagnosticV1> {
        self.service
            .inspect_sys(os_id)
            .await
            .map(|inspection| inspection.report)
            .map_err(|error| error.diagnostic().clone())
    }
}