rightsize 0.4.0

Tokio-async-native, RAII-guard integration-test containers — core API
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

#![warn(missing_docs)]
#![forbid(unsafe_code)]

//! `rightsize` is the backend-agnostic core of rightsize-rust: a Tokio-async-native,
//! RAII-guard API for booting integration-test containers and tearing them down
//! without leaks, no matter how the boot fails.
//!
//! This crate owns the public surface — the `Container` builder, the `ContainerGuard`
//! it returns, `Network`, wait strategies, the in-process free-port allocator, and the
//! `SandboxBackend` trait that lets `rightsize-msb` and `rightsize-docker` plug in
//! without this crate ever depending on either. It also owns everything about a
//! container's lifecycle past boot: own-run reaping and cross-run reuse, checkpoint
//! and restore (both ephemeral and named, durable ones any later process can
//! rediscover), copying files into a running container, live diagnostics, and gating
//! a start on hardware isolation via `.require_isolation(true)`.

mod archive;
pub mod backend;
pub mod backends;
pub mod cache_dir;
mod checkpoint;
mod cleanup;
mod container;
mod diagnostics;
pub mod error;
mod free_ports;
mod futures;
pub mod model;
pub mod mountable_file;
pub mod network;
mod reaper;
mod reuse;
mod run_id;
pub mod wait;

pub use backend::{
    BackendProvider, Capabilities, FollowHandle, NetworkLink, SandboxBackend, SandboxHandle,
};
pub use checkpoint::Checkpoint;
pub use container::{Container, ContainerGuard};
pub use diagnostics::{DiagnosticsGuard, diagnostics};
pub use error::{Result, RightsizeError};
pub use futures::BoxFuture;
pub use model::{ContainerSpec, ExecResult, FileMount, PortBinding};
pub use mountable_file::MountableFile;
pub use network::Network;
pub use run_id::RunId;
pub use wait::{Wait, WaitStrategy, WaitTarget};