nros_core/

lib.rs

//! Core types, traits, and abstractions for nros
//!
//! This crate provides the foundational types and traits for nros:
//! - `RosMessage` trait for message types
//! - `RosService` trait for service types
//! - `RosAction` trait for action types
//! - `ServiceServer` and `ServiceClient` for service communication
//! - Time and Duration types
//! - Error types

#![no_std]

// phase-359 W10 — no `std` feature; the test harness is hosted.
#[cfg(test)]
extern crate std;

// phase-361 W2 (final) / issue 0598 — `alloc` is THE heap predicate, in this
// exact spelling everywhere in the workspace. `std` reaches it through the
// MANIFEST (`std = ["alloc", …]`), not through a wider `cfg`.
//
// A `std` build links an allocator by definition, so it does have a heap, and a
// hosted consumer must not have to name `alloc` — but that implication belongs
// in one manifest line per crate, not in every `cfg`. Spelling it
// `any(alloc, std)` at the use sites was tried and reverted: it put the same
// fact in 123 places and left phase-359 (which DELETES `std` from these crates)
// with 88 extra branches to unwind, in `nros-node` above all. With the manifest
// edge, dropping `std` needs no `cfg` edit at all — these gates are already in
// their final form.
//
// Issue 0598 was never about which predicate: it was that THIS crate's heap
// gate and `nros-serdes`'s disagreed, so a `std`-only build got a `heap::Vec<T>`
// it could name and could not serialize. The fix is that `std` now forwards
// `alloc` here, so the types and their impls arrive together.
#[cfg(feature = "alloc")]
extern crate alloc;

pub mod action;
pub mod clock;
/// RFC-0090 / phase-429 — the codegen version, the one token that says whether
/// generated code and this runtime can work together.
///
/// # What breaks without it
///
/// nano-ros shipped prebuilt `nros` binaries early and stopped, because a
/// released binary emitted code that had drifted from the runtime. The failure
/// is not loud: drifted generated code *compiles*, and the image is simply
/// wrong in whatever way the generator was wrong. Issue 1018 records the
/// canonical instance — the C emitter transposed sequence-of-strings dimensions
/// in all three emission sites (`char data[256][64]` for `[64][256]`) — caught
/// by a developer's build refusal, which is a thing no user has.
///
/// The relation that breaks is **generated code ↔ runtime**. The binary is only
/// the thing that produced one side of it, which is why the version lives here,
/// in the runtime, rather than in the CLI.
///
/// # Why an integer and not a hash
///
/// A hash cannot say WHICH SIDE IS BEHIND, and that distinction is the whole
/// value of the token: `G < MIN` is "regenerate, silently" and `G > VERSION` is
/// "a human must move a pin". They are not interchangeable remedies. A hash
/// also moves when a doc comment moves, and a check that fires on cosmetic
/// change is one people learn to bypass — `NROS_SKIP_VERSION_CHECK` is right
/// there.
///
/// # Not to be confused with the codegen FINGERPRINT
///
/// `nros codegen-fingerprint` hashes every byte the emitters produce for a
/// compiled-in corpus. It answers *"would this binary emit different bytes?"* —
/// a FRESHNESS question, whose remedy is to regenerate, silently. The constants
/// here answer *"can this code work with this runtime?"* — a COMPATIBILITY
/// question, whose remedy is a refusal. Conflating them is why issue 1018's
/// stale-CLI refusal both over-fires on `cmd/doctor.rs` and cannot ship.
///
/// The module's own file carries no `//!` docs deliberately; see the comment at
/// its head.
///
/// # Where the negative case is proven
///
/// `just check codegen-version-refusal` builds artifacts carrying an
/// out-of-range version and requires each language to refuse: `#error` for C and
/// C++, `error[E0080]` for Rust. A check that has never been observed to fail is
/// a check nobody has evidence still works, and this one guards a failure whose
/// whole character is that it is silent.
pub mod codegen_version;
// issue 0783 — there is no `error` module here any more, and its absence is the
// decision. It held ~~`NanoRosError { code: RclReturnCode, context, nested }`~~, a
// phase-16 rclrs-shaped error, plus `RclReturnCode` (an `rcl_ret_t` numeric
// mirror), ~~`ErrorContext`~~, ~~`NestedError`~~, ~~`NanoRosErrorFilter`~~ and
// `TakeFailedAsNone`. Phase 84.D1 settled `NodeError` (nros-node) as the single
// user-facing error and deferred "folding NanoRosError into NodeError"; the fold
// never happened and nothing ever called the type. It was reachable from no
// public API: the `nros` facade never re-exported it, and this crate's own
// `RosAction::register_protocol_types` returns `Result<(), ()>` with a comment
// saying it cannot name an error type — with ~~`NanoRosError`~~ sitting in the same
// crate. RFC-0036's Errors row described it as the Rust user error for two
// years, which is the cost this deletion removes.
pub mod lifecycle;
pub mod logger;
pub mod message_info;
pub mod service;
pub mod service_info;
pub mod time;
pub mod types;

// phase-417 W4.b — `ActionClient` / `ActionServer` left this list with the two
// dead marker structs behind them; the live types under those names are
// `nros_node`'s, which is what `nros` re-exports.
pub use action::{
    CancelResponse, CancelResponseCode, GoalInfo, GoalResponse, GoalStatusCode, GoalStatusStamped,
    GoalUuid, RosAction,
};
#[allow(deprecated)]
pub use action::{CancelReturnCode, GoalId, GoalStatus};
pub use clock::{Clock, ClockType};
// RFC-0090 — generated code names these directly, so they are re-exported at
// the root: an emitted `const` assertion should not have to spell a module path
// that could be reorganised under it.
pub use codegen_version::{NROS_CODEGEN_VERSION, NROS_CODEGEN_VERSION_MIN};
pub use lifecycle::{LifecycleState, LifecycleTransition, TransitionResult};
pub use logger::{Logger, OnceFlag};
pub use message_info::{MessageInfo, PUBLISHER_GID_SIZE, RawMessageInfo, pad_publisher_gid};
pub use service::{ServiceCallback, ServiceClient, ServiceRequest, ServiceServer};
pub use service_info::{REQUEST_WRITER_GUID_SIZE, RequestId, ServiceInfo};
pub use time::{Duration, SecNanosecMsg, Time};
pub use types::{RosMessage, RosService, ViewableMessage};

// Re-export serdes types for convenience
pub use nros_serdes::{
    CdrReader, CdrWriter, DHeaderMark, DHeaderScope, DeserError, Deserialize, DeserializeView,
    EncodingVersion, LeDecode, LeSliceView, SerError, Serialize,
};

// Re-export heapless for generated message types
pub use heapless;

/// Heap-backed containers for generated `mode = "heap"` message fields
/// (RFC-0033). Gated on `alloc`, which `std` implies — so a hosted consumer
/// gets these by asking for `std` and never has to name `alloc`. `nros-serdes`
/// gates its matching `Serialize`/`Deserialize` impls on the SAME feature and
/// receives it through the same forward, which is what issue 0598 was about.
/// Generated code refers to `nros_core::heap::{Vec, String}` so the same path
/// works in both crate and inline (`build.rs`) codegen modes.
#[cfg(feature = "alloc")]
pub mod heap {
    pub use alloc::{string::String, vec::Vec};
}

/// RFC-0090 — tests for `codegen_version`, deliberately NOT inside that module's
/// file. `nros-build-helpers` and `rosidl-codegen` `include!` it verbatim, so
/// anything there is compiled into them too; the file is kept to constants and
/// `const fn`s, and its behaviour is exercised from here.
#[cfg(test)]
mod codegen_version_tests {
    use crate::codegen_version::*;

    // The non-empty-range invariant is NOT a test here: it is a property of two
    // constants, so it is a `const _: () = assert!(…)` in `codegen_version.rs`
    // and is checked at compile time in every crate that includes that file.
    // Written as a runtime test it is `clippy::assertions_on_constants`, which
    // is a hard error under `-D warnings`.

    #[test]
    fn accepts_the_range_and_nothing_outside_it() {
        assert!(accepts(NROS_CODEGEN_VERSION));
        assert!(accepts(NROS_CODEGEN_VERSION_MIN));
        assert!(
            !accepts(NROS_CODEGEN_VERSION + 1),
            "code emitted by a NEWER binary must be refused — the runtime is \
             the older side and cannot know what changed"
        );
        assert!(
            !accepts(NROS_CODEGEN_VERSION_MIN.saturating_sub(1)) || NROS_CODEGEN_VERSION_MIN == 0,
            "code below the floor must be refused, not silently accepted"
        );
    }

    /// Version 0 is reserved for "did not say".
    ///
    /// A generated artifact that carries no version reads as 0 through every
    /// path that parses one, and must never be accepted: an artifact that did
    /// not declare its version is exactly the pre-phase-429 artifact this
    /// mechanism exists to catch.
    #[test]
    fn zero_is_never_accepted() {
        assert!(!accepts(0));
    }
}