Instance Property

description

Short, lowercase identifier for the current case.

var description: String { get }

Return Value

"idle", "starting", "running", "stopping", "stopped", or "failed(<error>)".

Discussion

Intended for log lines and human-readable UI labels. The string returned is stable across releases and matches the case name; for .failed(_) it wraps the associated TorError’s CustomStringConvertible form inside "failed(…)" to keep the causal information visible at a glance.