nros/retired_env.rs
1//! phase-484 W8c — the RETIRED runtime env aliases and their canonical names.
2//!
3//! ONE table for both hosted env readers (`crate::env` and the `getenv` twin
4//! `crate::host_env`), so the two cannot disagree about which names refuse.
5//! A set retired name is [`BootConfigError::RetiredEnvVar`], never a silent
6//! skip: an ignored `ZENOH_LOCATOR` dials the backend's DEFAULT router, which
7//! reads as "no delivery" rather than as a configuration mistake.
8//!
9//! The gate `check-retired-runtime-aliases` refuses any other tracked reader
10//! of these names, so this file is the one place they are spelled in code.
11//!
12//! [`BootConfigError::RetiredEnvVar`]: nros_node::BootConfigError::RetiredEnvVar
13
14/// `(retired, replacement)` pairs, in the order the readers check them.
15pub const RETIRED_ENV_VARS: &[(&str, &str)] = &[
16 ("ZENOH_LOCATOR", "NROS_LOCATOR"),
17 ("ZENOH_MODE", "NROS_SESSION_MODE"),
18];