abpl 0.1.0

A collection of Rust boilerplate: a reloadable-systemd-service lifecycle helper, a hot-reloading axum wrapper, a serializable/typed error derive macro, and small utility newtypes.
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

//! # ABPL: Aritz's BoilerPlate Library
//! _A collection of junk that I only want to write once_
//!
//! Featuring:
//! - [abpl::app::service_main]: all you need to write a reloadable systemd service
//! - [abpl::app::axum::HotReloadingAxumService]: an axum service that can listen to multiple sockets while having
//!   zero-downtime reloads
//! - [abpl::Error]: an error macro that empowers you to create convenient-to-use error types that are typed and serializable
//!   (I feel like I'm underselling this)
//! - [abpl::future::block_on]: because OS threads are easier to debug during runtime but some widely-used crates needs the
//!   tokio runtime anyway
//! - Various newtypes
//! - And more!
//!
//! # Cargo features
//! Almost everything here is opt-in -- enable only what you need.
//!
//! - `std` (**default**): the standard library. `#![no_std]` support is aspirational, not
//!   functional -- disabling this today does not currently build (a few spots reach for
//!   `alloc`-provided items like `String`/`Box`/`format!` without actually importing them from
//!   `alloc`). Treat `std` as required until this note goes away.
//! - `serde`: `Serialize`/`Deserialize` for the error macro's generated types and other newtypes.
//! - `utoipa`: [utoipa::ToSchema] for the same types, for OpenAPI schema generation.
//! - `derive_error`: the [abpl::Error] derive macro itself, plus its `Display`/serde support.
//! - `app`: [abpl::app] -- the reloadable-systemd-service lifecycle helper (config parsing,
//!   logging setup, signal handling).
//! - `http`: axum/tokio integration -- [abpl::app::axum::HotReloadingAxumService] and the
//!   [abpl::types::http] socket abstractions. Implies `future_util`.
//! - `future_util`: [abpl::future::block_on]/[abpl::future::block_on_mt], the tokio-runtime
//!   bridging helpers.
//! - `thread`: [abpl::thread] -- currently just a cancelable sleep.
//! - `newtype_base64`: base64-encoded byte-array newtypes. Implies `serde`.
//! - `test`: bundles every feature the test suite needs. Not meant for downstream use --
//!   run tests with `--features test` rather than enabling it as a dependency feature.

#![cfg_attr(not(feature = "std"), no_std)]
extern crate self as abpl; // Makes the abpl_macros work internally.

#[cfg(feature = "derive_error")]
pub use abpl_macros::Error;
pub mod error;

#[cfg(all(feature = "app", feature = "std"))]
pub mod app;
pub mod providers;
#[cfg(feature = "std")]
pub mod sync;
#[cfg(feature = "thread")]
pub mod thread;
pub mod types;

pub mod maybe_std;

#[cfg(feature = "derive_error")]
pub mod deps {
	pub use indenter;
}

#[cfg(feature = "future_util")]
pub mod future;