Blitz.Result (blitz v0.3.0)

Copy Markdown View Source

Result metadata for a completed command.

Summary

Types

failure_kind()
t()

Functions

command_line(result)
failed?(result)
from_command(command, exit_code, duration_ms, output_tail)
startup_error(command, duration_ms, output_tail, reason)
timeout(command, duration_ms, output_tail, timeout_ms)
worker_crash(command, duration_ms, output_tail, reason)

Types

failure_kind()

@type failure_kind() :: :exit | :startup_error | :timeout | :worker_crash

t()

@type t() :: %Blitz.Result{
  args: [String.t()],
  cd: String.t() | nil,
  command: String.t(),
  duration_ms: non_neg_integer(),
  exit_code: non_neg_integer() | nil,
  failure_kind: failure_kind() | nil,
  failure_reason: String.t() | nil,
  id: String.t(),
  output_tail: [String.t()]
}

Functions

command_line(result)

@spec command_line(t()) :: String.t()

failed?(result)

@spec failed?(t()) :: boolean()

from_command(command, exit_code, duration_ms, output_tail)

@spec from_command(Blitz.Command.t(), non_neg_integer(), non_neg_integer(), [
  String.t()
]) :: t()

startup_error(command, duration_ms, output_tail, reason)

@spec startup_error(Blitz.Command.t(), non_neg_integer(), [String.t()], String.t()) ::
  t()

timeout(command, duration_ms, output_tail, timeout_ms)

@spec timeout(Blitz.Command.t(), non_neg_integer(), [String.t()], timeout()) :: t()

worker_crash(command, duration_ms, output_tail, reason)

@spec worker_crash(Blitz.Command.t(), non_neg_integer(), [String.t()], String.t()) ::
  t()