fettle

v1.0.0

fettle v1.0.0 Fettle.Checker.Result View Source

Result struct which is returned from Fettle.Checker functions.

Link to this section Summary

Types

message()
status()
t()

Functions

error(message)

error result shortcut

new(status, message)

create a new result with the current timestamp

new(status, message, timestamp)

create a new result with the supplied timestamp

ok(message \\ "OK")

ok result shortcut

warn(message)

warn result shortcut

Link to this section Types

Link to this type status() View Source 
status() :: :ok | :warn | :error
Link to this type t() View Source 
t() :: %Fettle.Checker.Result{
  message: message(),
  status: status(),
  timestamp: Fettle.TimeStamp.t()
}

Link to this section Functions

Link to this function error(message) View Source

error result shortcut.

Link to this function new(status, message) View Source

create a new result with the current timestamp

Link to this function new(status, message, timestamp) View Source

create a new result with the supplied timestamp

Link to this function ok(message \\ "OK") View Source

ok result shortcut.

Link to this function warn(message) View Source

warn result shortcut.