rust_supervisor/platform.rs
1//! Platform-conditional compilation declarations.
2//!
3//! This module documents the Unix-only strategy adopted by the project. The
4//! core supervision library compiles on all Rust targets, but the dashboard
5//! IPC subsystem requires Unix Domain Sockets and is gated behind
6//! `#[cfg(unix)]` at the crate root (`src/lib.rs`) and at the dashboard
7//! module level (`src/dashboard/mod.rs`).
8//!
9//! No Cargo feature gate is used — Rust's built-in `#[cfg(unix)]` provides
10//! compiler-enforced safety that prevents dashboard IPC code from appearing
11//! in non-Unix builds.
12
13/// Confirms the crate compiles in a Unix environment.
14///
15/// This constant exists only as a compile-time assertion. It is `true` on
16/// all Unix targets and absent on non-Unix targets.
17#[cfg(unix)]
18pub const UNIX_PLATFORM: bool = true;