Skip to main content

nido_core/
lib.rs

1// SPDX-License-Identifier: MIT OR Apache-2.0
2
3//! # nido-core — placeholder crate
4//!
5//! Brand-reservation placeholder for the Nido core library. The real
6//! `nido-core` ships at `>=0.1.0` with shared types and traits for the
7//! Nido multi-agent operating layer.
8//!
9//! See <https://crates.io/crates/nido> for the top-level binary and
10//! <https://securanido.com/nido> for the platform overview.
11
12#![forbid(unsafe_code)]
13#![warn(missing_docs)]
14#![doc(html_root_url = "https://docs.rs/nido-core/0.0.0-alpha.0")]
15
16/// Metadata returned by [`brand_reservation`].
17#[derive(Debug, Clone, Copy, PartialEq, Eq)]
18pub struct BrandReservation {
19    /// The reserved crate name.
20    pub name: &'static str,
21    /// The placeholder version.
22    pub version: &'static str,
23    /// Status.
24    pub status: &'static str,
25}
26
27/// Returns metadata about this brand-reservation placeholder.
28#[inline]
29pub const fn brand_reservation() -> BrandReservation {
30    BrandReservation {
31        name: "nido-core",
32        version: env!("CARGO_PKG_VERSION"),
33        status: "brand-reservation-placeholder",
34    }
35}
36
37#[cfg(test)]
38mod tests {
39    use super::*;
40
41    #[test]
42    fn brand_reservation_metadata_is_stable() {
43        assert_eq!(brand_reservation().name, "nido-core");
44    }
45}