huskarl-core 0.8.1

Base library for huskarl (OAuth2 client) ecosystem.
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

//! Extended documentation: how-to guides and explanation.
//!
//! The API items in this crate are the **reference** documentation — they say
//! what each utility is and how to call it. These pages cover the other
//! [Diátaxis](https://diataxis.fr) quadrants:
//!
//! - **[How-to guides](guide)** — task-oriented recipes for the things people
//!   reach for this crate to do: building and validating JWTs, providing
//!   secrets, and plugging in a transport or crypto backend.
//! - **[Explanation](explanation)** — understanding-oriented background on how
//!   the crate works and why it is shaped the way it is.
//!
//! This module is documentation only; it contains no runnable API. It is gated
//! on `cfg(docsrs)`, so its code blocks are real doctests that run only under
//! `RUSTDOCFLAGS="--cfg docsrs" cargo +nightly test --doc` (mirroring the
//! docs.rs build environment); a plain `cargo test --doc` skips them.

/// Task-oriented recipes for building JWTs, handling secrets, and plugging in
/// backends.
pub mod guide {
    #[doc = include_str!("../docs/guide/signing_a_jwt.md")]
    pub mod signing_a_jwt {}

    #[doc = include_str!("../docs/guide/validating_a_jwt.md")]
    pub mod validating_a_jwt {}

    #[doc = include_str!("../docs/guide/configuring_jwt_verification.md")]
    pub mod configuring_jwt_verification {}

    #[doc = include_str!("../docs/guide/providing_secrets.md")]
    pub mod providing_secrets {}

    #[doc = include_str!("../docs/guide/implementing_a_backend.md")]
    pub mod implementing_a_backend {}
}

/// Understanding-oriented background on how the crate works and why.
pub mod explanation {
    #[doc = include_str!("../docs/explanation/error_handling.md")]
    pub mod error_handling {}

    #[doc = include_str!("../docs/explanation/untrusted_keys.md")]
    pub mod untrusted_keys {}

    #[doc = include_str!("../docs/explanation/crypto_strategies.md")]
    // The metrics wrappers only exist behind the `metrics` feature, so their
    // intra-doc links would break a no-feature `cargo doc` (the crate denies
    // broken links). Append that section only when the feature is on; docs.rs
    // builds `all-features`, so the published docs still carry it.
    #[cfg_attr(
        feature = "metrics",
        doc = include_str!("../docs/explanation/crypto_strategies_metrics.md")
    )]
    pub mod crypto_strategies {}
}