Struct Diagnostics 

pub struct Diagnostics { /* private fields */ }

The write-only logging surface.

Holding one is the only way to write a log line in this crate, and it offers no way to read one back.

Implementations

impl Diagnostics

pub fn new(floor: Level, sink: Sink) -> Diagnostics

Writes every level at or before floor to sink.

pub fn off() -> Diagnostics

Writes nothing at all. The state the deletion-invariance test runs in, and a legitimate way to run the city.

pub fn floor(&self) -> Option<Level>

The current floor, for status to report. None is off.

pub fn admits(&self, level: Level) -> bool

Whether a level would be written. Offered so a caller can skip building an expensive message, not so it can branch on it.

pub fn write(&mut self, level: Level, site: Site<'_>, message: &str)

Writes one line, if the floor admits it.

The message passes the same secret scan the Ledger uses — the same function, not a second one, because the scanner nobody watches is the one that misses something. A hit is replaced in place: dropping the line would lose the diagnostic entirely, and the surrounding words are usually what the reader needed. A log line marks plainly: see crate::redact::Marker for why history and a log differ in that one argument and in nothing else.

Trait Implementations

impl Debug for Diagnostics

fn fmt(&self, f: &mut Formatter<'_>) -> Result

The sink is not printable, and the floor is the only state worth seeing. Manual rather than derived so a future field does not quietly acquire a Debug that prints what it logged.