spruce/symbol

Named terminal glyphs and ASCII fallbacks.

Use the Unicode constants for rich terminal output, and the _ascii constants when output must stay plain ASCII.

Types

Mode

Glyph rendering mode.

pub type Mode {
  Unicode
  Ascii
}

Constructors

```
Unicode
```
```
Ascii
```

Status

</>

Named status glyphs.

pub type Status {
  Info
  Warn
  Error
  Success
  Start
  Trace
  Debug
  Notice
  Alert
  Bullet
  Arrow
}

Constructors

```
Info
```
```
Warn
```
```
Error
```
```
Success
```
```
Start
```
```
Trace
```
```
Debug
```
```
Notice
```
```
Alert
```
```
Bullet
```
```
Arrow
```

Values

alert

</>

pub const alert: String

Alert message glyph.

arrow

</>

pub const arrow: String

Disclosure arrow glyph.

arrow_ascii

</>

pub const arrow_ascii: String

ASCII disclosure arrow glyph.

bullet

</>

pub const bullet: String

Bullet list glyph.

bullet_ascii

</>

pub const bullet_ascii: String

ASCII bullet list glyph.

debug

</>

pub const debug: String

Debug message glyph.

error

</>

pub const error: String

Error message glyph.

error_ascii

</>

pub const error_ascii: String

ASCII error glyph.

info

</>

pub const info: String

Informational message glyph.

info_ascii

</>

pub const info_ascii: String

ASCII informational glyph.

notice

</>

pub const notice: String

Notice message glyph.

resolve

</>

pub fn resolve(
  mode: Mode,
  unicode unicode: String,
  ascii ascii: String,
) -> String

Resolve a glyph pair according to the requested mode.

start

</>

pub const start: String

In-progress/start glyph.

start_ascii

</>

pub const start_ascii: String

ASCII in-progress/start glyph.

status

</>

pub fn status(mode: Mode, status: Status) -> String

Resolve a named status glyph according to the requested mode.

success

</>

pub const success: String

Success message glyph.

success_ascii

</>

pub const success_ascii: String

ASCII success glyph.

trace

</>

pub const trace: String

Trace/detail glyph.

warn

</>

pub const warn: String

Warning message glyph.

warn_ascii

</>

pub const warn_ascii: String

ASCII warning glyph.