tocat-plugins 0.1.0

The plugins compiled into tocat, a socat-inspired relay
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

//! Native plugins: implementations compiled into the tocat binary, as opposed
//! to WASM modules loaded at runtime.
//!
//! Both kinds implement [`tocat_api::Plugin`] and are looked up through the
//! same [`Registry`], so the relay cannot tell them apart.
//!
//! Every plugin is a module here, behind a cargo feature, and a feature enables
//! both the module and whatever optional dependencies it needs: a build without
//! `compress` never compiles zstd, and one without `wasm` never compiles
//! wasmtime. A crate boundary would buy nothing that does not already buy.
//!
//! [`register_native`] is the only thing this crate exports. No module can
//! reach another and the binary cannot reach any of them, which is what lets a
//! plugin change shape without anything above noticing.

#[cfg(feature = "block")]
mod block;

#[cfg(feature = "compress")]
mod compress;

#[cfg(feature = "limit")]
mod limit;

#[cfg(feature = "process")]
mod process;

#[cfg(feature = "rate")]
mod rate;

#[cfg(feature = "tee")]
mod tee;

#[cfg(feature = "throttle")]
mod throttle;

#[cfg(feature = "timeout")]
mod timeout;

#[cfg(feature = "wasm")]
mod wasm;

use tocat_api::Registry;

/// A registry containing every plugin compiled into this binary.
#[must_use]
pub fn native_registry() -> Registry {
    let mut registry = Registry::new();
    register_native(&mut registry);
    registry
}

/// Add the compiled-in plugins to an existing registry.
///
/// Separate from [`native_registry`] so a host that also loads WASM modules can
/// populate one registry from both sources.
pub fn register_native(registry: &mut Registry) {
    #[cfg(feature = "block")]
    registry.register(block::BlockFactory);

    #[cfg(feature = "compress")]
    {
        registry.register(compress::CompressFactory);
        registry.register(compress::DecompressFactory);
    }

    #[cfg(feature = "limit")]
    registry.register(limit::LimitFactory);

    #[cfg(feature = "process")]
    registry.register(process::ProcessFactory);

    #[cfg(feature = "rate")]
    registry.register(rate::RateFactory);

    #[cfg(feature = "tee")]
    registry.register(tee::TeeFactory);

    #[cfg(feature = "throttle")]
    registry.register(throttle::ThrottleFactory);

    #[cfg(feature = "timeout")]
    registry.register(timeout::TimeoutFactory);

    #[cfg(feature = "wasm")]
    registry.register(wasm::WasmFactory);

    // So clippy doesn't get mad if no features are enabled
    let _ = registry;
}