harmos-sidecar 0.1.6

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

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

/* === Modules === */

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

/* === Imports === */

// Standard Library Imports
use std::future::Future;
// Third Party Imports
use tokio::sync::{oneshot, watch};
// Local Imports
use super::carrier::{Input, Sender};
use super::{SharedOpening, exchange};
/* === Constants === */

/* === Macros === */

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

/* === Structs === */

/* === Enums === */

/* === Traits === */

/* === Implementations === */

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

pub(super) async fn run_binary(
    opening: SharedOpening, data: crate::transport::Io, control: crate::transport::Io, stop: impl Future<Output = ()>,
) -> std::io::Result<()> {
    run_binary_with_clock(opening, data, control, stop, super::host::published_at).await
}

pub(super) async fn run_binary_with_clock(
    opening: SharedOpening, data: crate::transport::Io, control: crate::transport::Io, stop: impl Future<Output = ()>,
    clock: fn() -> Option<i64>,
) -> std::io::Result<()> {
    let crate::transport::Connection { sender, receiver, mut driver } = crate::transport::Connection::new(data, control);
    let (completed, _completion) = oneshot::channel();
    let (closing, stopping) = watch::channel(false);
    let mut input = Input::Binary(receiver);
    let output = Sender::Binary(sender.clone());
    let mut serving = Box::pin(exchange(opening, &mut input, &output, completed, stopping, clock));
    let mut stop = Box::pin(stop);
    tokio::select! {
        result = &mut serving => {
            let flushed = tokio::select! {
                result = sender.drain() => result,
                result = driver.run() => result,
                _ = &mut stop => Ok(()),
            };
            sender.close();
            let ended = driver.run().await;
            result.map_err(std::io::Error::other)?;
            flushed?;
            ended
        },
        result = driver.run() => {
            if let Err(error) = result { tracing::debug!(%error, "binary sidecar transport ended"); }
            closing.send_replace(true);
            serving.await.map_err(std::io::Error::other)
        },
        _ = &mut stop => {
            sender.close();
            closing.send_replace(true);
            let settled = serving.await;
            let _ = driver.run().await;
            settled.map_err(std::io::Error::other)
        }
    }
}

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

/* === Tests === */