<!--
{
  "availability" : [

  ],
  "documentType" : "symbol",
  "framework" : "Tor",
  "identifier" : "/documentation/Tor/TorState/description",
  "metadataVersion" : "0.1.0",
  "role" : "Instance Property",
  "symbol" : {
    "kind" : "Instance Property",
    "modules" : [
      "Tor"
    ],
    "preciseIdentifier" : "s:3Tor0A5StateO11descriptionSSvp"
  },
  "title" : "description"
}
-->

# 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`](/documentation/Tor/TorError)’s
`CustomStringConvertible` form inside `"failed(…)"` to keep the
causal information visible at a glance.