API Reference

Generate exact signatures locally with:

./gradlew dokkaGeneratePublicationHtml

Public Surface

  • Throwables.Policy: traversal and propagation policy.
  • Throwables.defaultPolicy: low-allocation default policy.
  • Throwables.strictPolicy: allocating policy that scans suppressed throwable graphs.
  • Throwables.Verdict: YES, NO, or UNKNOWN classification result.
  • Throwables.OnMaxDepth: behavior when traversal reaches maxDepth.
  • Throwables.ControlFlowDetection: platform control-flow detection mode.
  • Throwables.MaxDepthExceededError: thrown when max-depth behavior is configured to throw.
  • Throwables.isFatalError, isInterruption, isCoroutineCancellation, isCancellation, isControlFlow, and isContractViolation: classification helpers.
  • Throwables.mustPropagate: returns null when no propagation is needed, or the throwable that should be rethrown under the active policy.
  • Throwables.propagateIfNeeded: rethrows the result of mustPropagate, restoring interruption first when configured.
  • Throwables.restoreInterruptIfNeeded: restores an interrupt flag when supported by the platform.
  • Throwables.unwrapCommonWrappers and isCommonWrapper: wrapper-inspection helpers.
  • Throwables.swallowAll: runs a block at most once, rethrows propagating failures, and converts non-propagating failures into null.
  • Throwables.rootCause and Throwable.rootCause: root-cause helpers.
  • Throwables.addSuppressedBestEffort and handleSuppressed: suppressed-failure helpers.

See the generated Dokka output for platform availability and Java interop names.