Instance Property

description

Human-readable, stable string representation of this error.

var description: String { get }

Return Value

A short sentence describing the error. Associated-value cases include their payload in a sensible template (e.g. "Tor failed to start: <reason>").

Discussion

Each case renders to a concise English sentence suitable for log lines, CLI diagnostics, and fallback UI labels. Strings are deliberately stable across minor releases — do not pattern-match against them; pattern-match against the enum case instead.

Important

This is not a LocalizedError.errorDescription; Apple UI surfaces that call error.localizedDescription will fall back to the opaque case name. Render via "\(error)" or error.description when user-facing copy is needed.