Module

poke/failure

src/poke/failure.pooka

Keep a failure in a small, labelled box before deciding how to show it. Comparisons retain separate expected and actual text, formatted with the same plain printer used for snapshots. Capture observes exceptions in this process; it does not impose a deadline or undo the callback's effects.

API reference

enum

Kind

src/poke/failure.pooka:12
enum Kind

Every assertion family has a stable category, without exposing BEAM terms.

variant

Comparison

src/poke/failure.pooka:13
Kind.Comparison
variant

Assertion

src/poke/failure.pooka:14
Kind.Assertion
variant

Panic

src/poke/failure.pooka:15
Kind.Panic
variant

Exception

src/poke/failure.pooka:16
Kind.Exception
class

Failure

src/poke/failure.pooka:19
class Failure(
  kind: Kind,
  message: String,
  expected: Option(String),
  actual: Option(String)
)
field

kind

src/poke/failure.pooka:20
kind: Kind
field

message

src/poke/failure.pooka:21
message: String
INFERREDString
field

expected

src/poke/failure.pooka:22
expected: Option(String)
INFERREDOption(String)
field

actual

src/poke/failure.pooka:23
actual: Option(String)
INFERREDOption(String)
constructor

new

src/poke/failure.pooka:20
INFERREDfn(poke/failure.Kind, String, Option(String), Option(String)) -> poke/failure.Failure
function

capture

src/poke/failure.pooka:39
capture(run: fn() -> a) -> Result(a, Failure)
INFERREDfn(fn() -> a) -> Result(a, poke/failure.Failure)

Observe an assertion, panic or foreign exception as structured data.

Pooka
let problem = failure.capture(fn() { should.equal(1, 2) }) |> should.be_error()
should.equal(problem.expected, Some("2"))
function

compare

src/poke/failure.pooka:55
compare(actual: a, expected: a, label: String) -> Result(Nil, Failure)
INFERREDfn(a, a, String) -> Result(Nil, poke/failure.Failure)

Build a comparison without raising, useful for custom assertion libraries.

function

describe

src/poke/failure.pooka:68
describe(problem: Failure) -> String
INFERREDfn(poke/failure.Failure) -> String

Format one complete report. No terminal colours or presentation truncation.