nido-commit 0.0.0-alpha.0

Brand-reservation placeholder for the nido-commit crate in the Nido / Securanido platform. Real implementation ships at >=0.1.0.
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

// SPDX-License-Identifier: MIT OR Apache-2.0
//! # nido-commit — brand-reservation placeholder
//!
//! This crate is a brand-reservation placeholder for the
//! nido-commit component of the Nido / Securanido platform.
//!
//! The real nido-commit implementation ships at version >= 0.1.0.
//! See <https://securanido.com> for the project homepage and roadmap.

#![forbid(unsafe_code)]
#![doc(html_root_url = "https://docs.rs/nido-commit/0.0.0-alpha.0")]

/// Brand-reservation metadata. The single public API of this placeholder.
pub struct BrandReservation {
    pub name: &'static str,
    pub version: &'static str,
    pub status: &'static str,
    pub homepage: &'static str,
}

/// Returns the reservation record for this crate name.
pub const fn brand_reservation() -> BrandReservation {
    BrandReservation {
        name: "nido-commit",
        version: "0.0.0-alpha.0",
        status: "placeholder; real release at >=0.1.0",
        homepage: "https://securanido.com",
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn placeholder_metadata_is_stable() {
        let r = brand_reservation();
        assert_eq!(r.name, "nido-commit");
        assert_eq!(r.version, "0.0.0-alpha.0");
    }
}