malkuth 0.1.0

A composable service-supervision toolkit for Rust
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

//! # malkuth
//!
//! Service-supervision toolkit for long-running Rust programs: JSON-RPC over
//! pluggable transports (TCP / WebSocket / IPC), supervised workers, split
//! health probes, coordination locks and lease-based leader election.
//!
//! ## Feature flags
//!
//! | Feature | What it enables |
//! | --- | --- |
//! | `tcp` *(default)* | TCP JSON-RPC transport |
//! | `ws` | WebSocket transport |
//! | `ipc` | Unix-domain-socket / named-pipe transport |
//! | `signals` *(default)* | OS-signal exit source (SIGINT/TERM/HUP/QUIT) |
//! | `worker` | OTP-style child-process supervision |
//! | `probes` | axum `/healthz` + `/readyz` routes |
//! | `file-lock` | POSIX `flock` coordination-lock backend (Unix only) |
//! | `lease` | File-lease lock with TTL auto-expiry |
//! | `pg-lock` | PostgreSQL advisory-lock backend |
//! | `replica` | In-memory instance registry |
//! | `leader-follower` | Lease-based leader elector |
//! | `cli` | `malkuth` watchdog binary (pod pool + sticky proxy) |

// ── Layer 1: lifecycle & wire types ────────────────────────────
pub mod hooks;
pub mod lifecycle;
pub mod traits;
pub mod types;
pub mod wire;

// ── Layer 2: coordination backends ─────────────────────────────
#[cfg(feature = "lease")]
pub mod lease;
#[cfg(all(unix, feature = "file-lock"))]
pub mod lock;

// ── Layer 3: JSON-RPC + transports ─────────────────────────────
pub mod client;
pub mod codec;
pub mod jsonrpc;
pub mod server;
pub mod service;

#[cfg(any(feature = "tcp", feature = "ws", feature = "ipc"))]
pub mod transport;

// ── Layer 4: runtime facilities ────────────────────────────────
#[cfg(feature = "leader-follower")]
pub mod leader;
#[cfg(feature = "pg-lock")]
pub mod pg_lock;
#[cfg(feature = "probes")]
pub mod probes;
#[cfg(feature = "replica")]
pub mod registry;
#[cfg(feature = "signals")]
pub mod signals;
#[cfg(feature = "worker")]
pub mod worker;

// ── Convenience re-exports ─────────────────────────────────────
pub use hooks::{DrainHook, ExitReason, ExitSource, Heartbeat, HeartbeatReport, ProbeSink};
pub use jsonrpc::{Id, Request, Response, Router, RpcError, RpcHandler};
pub use lifecycle::{DrainController, ShutdownKind};
pub use traits::{CoordinationLock, InstanceRegistry, LeaderElector, LockError, LockGuard};
pub use types::*;
pub use wire::{Transport, WireConn, WireListener};

pub use client::{Client, ClientPool};
pub use server::Server;
pub use service::Supervised;

#[cfg(feature = "worker")]
pub use worker::{Supervisor, WorkerSpec};

#[cfg(feature = "probes")]
pub use probes::{ProbeState, probe_router};