# src.SandboxCanary

- **Module:** src
- **Package:** libtmux
- **Language:** Rust
- **Kind:** struct
- **Source:** https://github.com/libtmux/libtmux-rs/blob/2c165c4433d1bdb747a350bd460364daa4a06a55/crates/libtmux/src/lib.rs#L511
- **Page:** https://libtmux.org/en/rs/latest/reference/src-sandboxcanary/

Checks that a doctest runs inside the tmux sandbox.

Each doctest is its own process, so the sandbox reaches it only through
the environment. `scripts/check-doctest-sandbox.sh` runs this and breaks the
sandbox to show it fails. Only the checkout has the included file.