harmos-sdk 0.1.2

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
64
65
66
67

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

/* === Modules === */

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

pub use harmos_domain::operations::instance::*;

/* === Imports === */

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

// Third Party Imports

// Local Imports
use super::{OperationDeclaration, Response};

/* === Constants === */

/* === Macros === */

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

/* === Structs === */

/* === Enums === */

/* === Traits === */

// One submitted operation. Dropping an unsettled instance requests its
// cancellation; `detach` hands the instance to the host and keeps it running.
pub trait Instance<O: OperationDeclaration>: Send + Sized {
    type Error: std::error::Error + Send + Sync + 'static;

    fn id(&self) -> Id;

    fn status(&self) -> impl Future<Output = Result<Status, Self::Error>> + Send;

    fn cancel(&self) -> impl Future<Output = Result<(), Self::Error>> + Send;

    fn join(self) -> impl Future<Output = Result<Response<O::Response>, Self::Error>> + Send;

    fn cancel_and_join(self) -> impl Future<Output = Result<Response<O::Response>, Self::Error>> + Send {
        async move {
            self.cancel().await?;
            self.join().await
        }
    }

    fn detach(self) -> Id;
}

/* === Implementations === */

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

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

/* === Tests === */