licence_audit/progress

Types

Event

pub type Event {
  Event(kind: EventKind, message: String)
}

Constructors

```
Event(kind: EventKind, message: String)
```

EventKind

</>

pub type EventKind {
  Phase
  Detail
  PackageCount
  Success
  Failure
  Warning
  Error
}

Constructors

```
Phase
```
```
Detail
```
```
PackageCount
```
```
Success
```
```
Failure
```
```
Warning
```
```
Error
```

Level

</>

pub type Level {
  DebugLevel
  InfoLevel
  WarnLevel
  ErrorLevel
  FatalLevel
}

Constructors

```
DebugLevel
```
```
InfoLevel
```
```
WarnLevel
```
```
ErrorLevel
```
```
FatalLevel
```

LogEntry

</>

pub type LogEntry {
  LogEntry(
    level: Level,
    logger_name: String,
    message: String,
    metadata: List(#(String, String)),
  )
}

Constructors

LogEntry(
  level: Level,
  logger_name: String,
  message: String,
  metadata: List(#(String, String)),
)

Reporter

</>

pub type Reporter {
  Reporter(
    enabled: Bool,
    verbosity: Verbosity,
    emit: Bool,
    events: List(Event),
    deferred: List(Event),
    command: String,
    color: color.Mode,
  )
}

Constructors

Reporter(
  enabled: Bool,
  verbosity: Verbosity,
  emit: Bool,
  events: List(Event),
  deferred: List(Event),
  command: String,
  color: color.Mode,
)

Verbosity

</>

pub type Verbosity {
  Quiet
  Normal
  Verbose
}

Constructors

```
Quiet
```
```
Normal
```
```
Verbose
```

Values

capturing

</>

pub fn capturing(
  verbosity: Verbosity,
  command: String,
) -> Reporter

defer_error

</>

pub fn defer_error(
  reporter: Reporter,
  message: String,
) -> Reporter

Record a fatal audit error and queue its log emission until flush is called. Mirrors error in that it records even when verbosity is Quiet.

defer_success

</>

pub fn defer_success(
  reporter: Reporter,
  message: String,
) -> Reporter

Record a success event and queue its log emission until flush is called. Use this for end-of-run status messages that should appear after report output has been printed to stdout.

defer_warn

</>

pub fn defer_warn(
  reporter: Reporter,
  message: String,
) -> Reporter

Record a warning event and queue its log emission until flush is called.

detail

</>

pub fn detail(reporter: Reporter, message: String) -> Reporter

disabled

</>

pub fn disabled() -> Reporter

enabled

</>

pub fn enabled(
  verbosity: Verbosity,
  command: String,
  color: color.Mode,
) -> Reporter

events

</>

pub fn events(reporter: Reporter) -> List(Event)

fail

</>

pub fn fail(reporter: Reporter, message: String) -> Reporter

flush

</>

pub fn flush(reporter: Reporter) -> Reporter

Emit any deferred log entries (in the order they were deferred) and clear the deferred queue. Safe to call on capturing or disabled reporters.

format_level

</>

pub fn format_level(level: Level, use_color: Bool) -> String

format_standard_record

</>

pub fn format_standard_record(
  record: LogEntry,
  use_color: Bool,
) -> String

format_tty_record

</>

pub fn format_tty_record(
  record: LogEntry,
  use_color: Bool,
) -> String

package_count

</>

pub fn package_count(reporter: Reporter, count: Int) -> Reporter

phase

</>

pub fn phase(reporter: Reporter, message: String) -> Reporter

stderr_color_enabled

</>

pub fn stderr_color_enabled(
  mode: color.Mode,
  level: tty.ColorLevel,
) -> Bool

success

</>

pub fn success(reporter: Reporter, message: String) -> Reporter

warn

</>

pub fn warn(reporter: Reporter, message: String) -> Reporter