harmos-sidecar 0.1.5

Harmos sidecar transport and kit for out-of-process plugins.
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

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

/* === Modules === */

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

/* === Imports === */

// Standard Library Imports
use std::io;
// Third Party Imports
// Local Imports
use crate::{Frame, transport};

/* === Constants === */

/* === Macros === */

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

/* === Structs === */

pub(super) struct Arrival {
    pub frame: Frame,
    pub cancelled: bool,
    pub consumption: Option<transport::Consumption>,
}

/* === Enums === */

pub(super) enum Failure {
    Invalid(String),
    Capacity,
    Panicked,
}

pub(super) enum Input {
    Binary(transport::Receiver),
}

pub(super) enum Sender {
    Binary(transport::Sender),
}

/* === Traits === */

/* === Implementations === */

impl Input {
    pub async fn receive(&mut self) -> io::Result<Option<Arrival>> {
        let Self::Binary(input) = self;
        Ok(input.receive().await?.map(|received| Arrival {
            frame: received.frame,
            cancelled: received.cancelled,
            consumption: received.consumption,
        }))
    }
}

impl Sender {
    pub async fn send(&self, frame: Frame) -> io::Result<()> {
        let Self::Binary(output) = self;
        output.send(frame).await
    }

    pub fn fail(&self, failure: Failure) {
        let Self::Binary(output) = self;
        match failure {
            Failure::Invalid(message) => tracing::debug!(%message, "invalid sidecar frame"),
            Failure::Capacity => tracing::debug!("sidecar request queue exhausted"),
            Failure::Panicked => tracing::debug!("sidecar request handler panicked"),
        }
        output.close();
    }
}

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

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

/* === Tests === */