harmos-sdk 0.1.8

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
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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146

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

/* === Modules === */

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

/* === Imports === */

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

// Third Party Imports

// Local Imports
use super::{ExecutionContext, FailureKind, OperationDeclaration};

/* === Constants === */

/* === Macros === */

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

/* === Structs === */

/* === Enums === */

/* === Traits === */

pub trait EndpointSet: Send + Sized + 'static {
    fn empty() -> Option<Self> {
        None
    }

    #[cfg(feature = "streaming")]
    fn bind_wire(_limits: super::WireStreamLimits) -> Result<(Self, super::WireStreams), super::ServingError> {
        Err(super::ServingError::StreamUnsupported)
    }

    fn item_types() -> (Option<std::any::TypeId>, Option<std::any::TypeId>);
    fn transferred(&self) -> bool {
        Self::item_types() != (None, None)
    }
}

pub trait InputEndpoint: Send + Sized + 'static {
    #[cfg(feature = "streaming")]
    fn bind_wire(_limits: super::WireStreamLimits) -> Result<(Self, super::WireStreams), super::ServingError> {
        Err(super::ServingError::StreamUnsupported)
    }

    type Item: Send + 'static;
    fn transferred(&self) -> bool {
        true
    }
}
pub trait OutputEndpoint: Send + Sized + 'static {
    #[cfg(feature = "streaming")]
    fn bind_wire(_limits: super::WireStreamLimits) -> Result<(Self, super::WireStreams), super::ServingError> {
        Err(super::ServingError::StreamUnsupported)
    }

    type Item: Send + 'static;
    fn transferred(&self) -> bool {
        true
    }
}

// The Instance Contract Behind Every Registered Operation: Carrier Proxies,
// Lifecycle Built-Ins And Authored Operations Through `Authored`.
#[doc(hidden)]
pub trait Carrier: Send + Sized + 'static {
    type Declaration: OperationDeclaration;
    type Error: std::error::Error + Send + Sync + 'static;
    type StreamEndpoints: EndpointSet;

    fn bind(context: ExecutionContext) -> impl Future<Output = Result<Self, Self::Error>> + Send;

    fn attempt(
        &mut self, context: ExecutionContext, request: &mut <Self::Declaration as OperationDeclaration>::Request,
        endpoints: &mut Self::StreamEndpoints,
    ) -> impl Future<Output = Result<super::Response<<Self::Declaration as OperationDeclaration>::Response>, Self::Error>> + Send;

    fn stop(&mut self) -> impl Future<Output = Result<(), Self::Error>> + Send {
        async { Ok(()) }
    }

    fn cleanup(&mut self) -> impl Future<Output = Result<(), Self::Error>> + Send {
        async { Ok(()) }
    }

    fn transferred(&self) -> bool {
        false
    }

    fn classify(_error: &Self::Error) -> FailureKind {
        FailureKind::Permanent
    }
}

// Selects The Carrier That Executes A Declaration.
pub trait Executable: OperationDeclaration {
    type Carrier: Carrier<Declaration = Self>;

    // Registration Verifies The Carrier Resources.
    const RESOURCES: &'static [super::Resource] = &[];
}

/* === Implementations === */

impl EndpointSet for () {
    fn empty() -> Option<Self> {
        Some(())
    }
    fn item_types() -> (Option<std::any::TypeId>, Option<std::any::TypeId>) {
        (None, None)
    }
}

impl<I: InputEndpoint, O: OutputEndpoint> EndpointSet for (I, O) {
    #[cfg(feature = "streaming")]
    fn bind_wire(limits: super::WireStreamLimits) -> Result<(Self, super::WireStreams), super::ServingError> {
        let (input, incoming) = I::bind_wire(limits)?;
        let (output, outgoing) = O::bind_wire(limits)?;
        Ok(((input, output), incoming.combine(outgoing)))
    }

    fn transferred(&self) -> bool {
        self.0.transferred() || self.1.transferred()
    }
    fn item_types() -> (Option<std::any::TypeId>, Option<std::any::TypeId>) {
        (Some(std::any::TypeId::of::<I::Item>()), Some(std::any::TypeId::of::<O::Item>()))
    }
}

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

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

/* === Tests === */