harmos-sdk 0.1.13

Harmos SDK for authoring plugins and operations over the Harmos runtime.
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

/* ***
 *
 * Harmos
 *
 * SPDX-License-Identifier: Apache-2.0
 *
 * ***
 */

// Shared Application And Plugin Lifecycle

/* === Modules === */

/* === Re-Exports === */

pub use crate::setup::{ApplicationConfiguration, SetupConfiguration};

/* === Imports === */

// Standard Library Imports
use std::future::Future;

// Third Party Imports
use serde::de::DeserializeOwned;

// Local Imports
use crate::setup::Setup;

/* === Constants === */

/* === Macros === */

/* === Type Aliases === */

/* === Structs === */

/* === Enums === */

/* === Traits === */

pub trait Context: Clone + Send + Sync + 'static {
    #[doc(hidden)]
    type Configuration: SetupConfiguration;
}

pub trait Lifecycle: Sized + Send + 'static {
    type Config: DeserializeOwned + Default + Send + 'static;
    type Error: std::error::Error + Send + Sync + 'static;
    type Context: Context;

    fn prepare(config: Self::Config, setup: &mut Setup<Self>) -> impl Future<Output = Result<Self, Self::Error>> + Send;
    fn initialize(&mut self, context: &Self::Context) -> impl Future<Output = Result<(), Self::Error>> + Send;
    fn stop(&mut self, context: &Self::Context) -> impl Future<Output = Result<(), Self::Error>> + Send;
    fn cleanup(&mut self) -> impl Future<Output = Result<(), Self::Error>> + Send;
}

/* === Implementations === */

/* === Public Functions === */

/* === Private Functions === */

/* === Tests === */