Skip to main content

nido_commit/
lib.rs

1// SPDX-License-Identifier: MIT OR Apache-2.0
2//! # nido-commit — brand-reservation placeholder
3//!
4//! This crate is a brand-reservation placeholder for the
5//! nido-commit component of the Nido / Securanido platform.
6//!
7//! The real nido-commit implementation ships at version >= 0.1.0.
8//! See <https://securanido.com> for the project homepage and roadmap.
9
10#![forbid(unsafe_code)]
11#![doc(html_root_url = "https://docs.rs/nido-commit/0.0.0-alpha.0")]
12
13/// Brand-reservation metadata. The single public API of this placeholder.
14pub struct BrandReservation {
15    pub name: &'static str,
16    pub version: &'static str,
17    pub status: &'static str,
18    pub homepage: &'static str,
19}
20
21/// Returns the reservation record for this crate name.
22pub const fn brand_reservation() -> BrandReservation {
23    BrandReservation {
24        name: "nido-commit",
25        version: "0.0.0-alpha.0",
26        status: "placeholder; real release at >=0.1.0",
27        homepage: "https://securanido.com",
28    }
29}
30
31#[cfg(test)]
32mod tests {
33    use super::*;
34
35    #[test]
36    fn placeholder_metadata_is_stable() {
37        let r = brand_reservation();
38        assert_eq!(r.name, "nido-commit");
39        assert_eq!(r.version, "0.0.0-alpha.0");
40    }
41}