JustBash.Result (JustBash v0.4.0)

View Source

Represents the result of executing a command or script.

Contains stdout, stderr, exit code, and optional control flow signals.

Control Flow Signals

Shell control flow (break, continue, return) is handled through the signal field:

  • nil - No signal, normal execution
  • {:break, n} - Break from n loop levels
  • {:continue, n} - Continue at n loop levels
  • {:return, code} - Return from function with exit code

Summary

Types

signal()
t()

Functions

break(level \\ 1)

Creates a result with a break signal.

break?(result)

Checks if the result has a break signal.

continue(level \\ 1)

Creates a result with a continue signal.

continue?(result)

Checks if the result has a continue signal.

decrement_signal(result)

Decrements the signal level by 1. Returns nil if level reaches 0. Only applicable to break and continue signals.

error(stderr, exit_code \\ 1)

Creates an error result with the given stderr and exit code.

from_map(map)

Converts from a plain map (for backward compatibility during migration).

has_signal?(result)

Checks if the result has any control flow signal.

merge_output(target, source)

Merges output from one result into another, preserving the signal from source if present.

new(attrs \\ [])

Creates a new result with the given attributes.

ok(stdout \\ "")

Creates a successful result with the given stdout.

return(exit_code \\ 0)

Creates a result with a return signal.

return?(result)

Checks if the result has a return signal.

to_map(result)

Converts to a plain map (for backward compatibility during migration).

Types

signal()

@type signal() ::
  {:break, pos_integer()}
  | {:continue, pos_integer()}
  | {:return, non_neg_integer()}
  | nil

t()

@type t() :: %JustBash.Result{
  exit_code: non_neg_integer(),
  signal: signal(),
  stderr: String.t(),
  stdout: String.t()
}

Functions

break(level \\ 1)

@spec break(pos_integer()) :: t()

Creates a result with a break signal.

break?(result)

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

Checks if the result has a break signal.

continue(level \\ 1)

@spec continue(pos_integer()) :: t()

Creates a result with a continue signal.

continue?(result)

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

Checks if the result has a continue signal.

decrement_signal(result)

@spec decrement_signal(t()) :: t()

Decrements the signal level by 1. Returns nil if level reaches 0. Only applicable to break and continue signals.

error(stderr, exit_code \\ 1)

@spec error(String.t(), non_neg_integer()) :: t()

Creates an error result with the given stderr and exit code.

from_map(map)

@spec from_map(map()) :: t()

Converts from a plain map (for backward compatibility during migration).

has_signal?(result)

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

Checks if the result has any control flow signal.

merge_output(target, source)

@spec merge_output(t(), t()) :: t()

Merges output from one result into another, preserving the signal from source if present.

new(attrs \\ [])

@spec new(keyword()) :: t()

Creates a new result with the given attributes.

Examples

iex> JustBash.Result.new()
%JustBash.Result{stdout: "", stderr: "", exit_code: 0, signal: nil}

iex> JustBash.Result.new(stdout: "hello\n", exit_code: 0)
%JustBash.Result{stdout: "hello\n", stderr: "", exit_code: 0, signal: nil}

ok(stdout \\ "")

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

Creates a successful result with the given stdout.

return(exit_code \\ 0)

@spec return(non_neg_integer()) :: t()

Creates a result with a return signal.

return?(result)

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

Checks if the result has a return signal.

to_map(result)

@spec to_map(t()) :: map()

Converts to a plain map (for backward compatibility during migration).