nido-core 0.0.0-alpha.0

Pre-release metadata crate. Real Nido core types and traits ship 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
42
43
44
45

// SPDX-License-Identifier: MIT OR Apache-2.0

//! # nido-core — placeholder crate
//!
//! Brand-reservation placeholder for the Nido core library. The real
//! `nido-core` ships at `>=0.1.0` with shared types and traits for the
//! Nido multi-agent operating layer.
//!
//! See <https://crates.io/crates/nido> for the top-level binary and
//! <https://securanido.com/nido> for the platform overview.

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

/// Metadata returned by [`brand_reservation`].
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct BrandReservation {
    /// The reserved crate name.
    pub name: &'static str,
    /// The placeholder version.
    pub version: &'static str,
    /// Status.
    pub status: &'static str,
}

/// Returns metadata about this brand-reservation placeholder.
#[inline]
pub const fn brand_reservation() -> BrandReservation {
    BrandReservation {
        name: "nido-core",
        version: env!("CARGO_PKG_VERSION"),
        status: "brand-reservation-placeholder",
    }
}

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

    #[test]
    fn brand_reservation_metadata_is_stable() {
        assert_eq!(brand_reservation().name, "nido-core");
    }
}