Safe

h8io.stages.operators.Safe
final case class Safe[-I, +O, +E](alterand: Stage[I, O, E]) extends Alterator[Stage[I, O, E], I, O, Either[Throwable, E]], SafeStage[I, O, Either[Throwable, E]]

A decorator that catches non-fatal exceptions thrown by the inner stage and converts them into h8io.stages.Status.Complete error values.

The error type is widened from E to Either[Throwable, E]:

  • Errors already carried by the inner stage are wrapped as Right(e).
  • Exceptions caught during apply are reported as Left(throwable) in a Yield.None(Status.error(Left(e)), this).

Only non-fatal exceptions (matched by scala.util.control.NonFatal) are caught; fatal errors such as OutOfMemoryError propagate normally.

The evolution is mapped so that every continuation stage remains wrapped in Safe, maintaining exception safety across the entire pipeline.

Safe is a crutch for the simplest cases — ''stateless'' stages. Per the ''Lifecycle'' contract in h8io.stages.Stage, a stage that throws from apply has already released its own resources, so the recovered continuation simply reuses the inner stage — retrying it on the next input — and carries a no-op dispose. A stage that owns resources should be made safe by itself instead of being wrapped: extend h8io.stages.base.SafeStage and supply a recover with the appropriate cleanup (the h8io.stages.base.ConstEvolution overload taking a dispose function exists for exactly this).

Type parameters

E

the original error type of the inner stage (covariant)

I

the input type (contravariant)

O

the output type (covariant)

Value parameters

alterand

the inner stage whose exceptions should be caught

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait SafeStage[I, O, Either[Throwable, E]]
trait Alterator[Stage[I, O, E], I, O, Either[Throwable, E]]
trait Stage[I, O, Either[Throwable, E]]
trait I => Yield[I, O, Either[Throwable, E]]
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

override def body(in: I): Yield[I, O, Either[Throwable, E]]

The main execution logic invoked on each input.

The main execution logic invoked on each input.

Value parameters

in

the input value

Attributes

Returns

a h8io.stages.Yield representing the result

Definition Classes
override def recover(in: I, e: Throwable): Yield[I, O, Either[Throwable, E]]

Called when body throws a non-fatal exception.

Called when body throws a non-fatal exception.

Value parameters

e

the non-fatal exception thrown by body

in

the input value that was being processed when the exception occurred

Attributes

Returns

a h8io.stages.Yield representing the error outcome

Definition Classes
override def skip(): Evolution[I, O, Either[Throwable, E]]

Returns this stage's Evolution without consuming an input.

Returns this stage's Evolution without consuming an input.

Called instead of apply whenever the stage takes part in a run but has nothing to process: the upstream yielded no output, or a binary operator excluded this branch. The evolution must be the one the stage would have returned had it run. Like apply, skip() may perform side effects — a decorator, for instance, may advance or release the inner stage it owns.

Attributes

Definition Classes

Inherited methods

def andThen[A](g: Yield[I, O, Either[Throwable, E]] => A): I => A

Composes two instances of Function1 in a new Function1, with this function applied first.

Composes two instances of Function1 in a new Function1, with this function applied first.

Type parameters

A

the result type of function g

Value parameters

g

a function R => A

Attributes

Returns

a new function f such that f(x) == g(apply(x))

Inherited from:
Function1
final override def apply(in: I): Yield[I, O, Either[Throwable, E]]

Processes in and returns the Yield carrying the optional output, the status and the continuation.

Processes in and returns the Yield carrying the optional output, the status and the continuation.

A stage that throws from here must have released its own resources first — see the ''Lifecycle'' section above.

Attributes

Definition Classes
SafeStage -> Stage -> Function1
Inherited from:
SafeStage
def compose[A](g: A => I): A => Yield[I, O, Either[Throwable, E]]

Composes two instances of Function1 in a new Function1, with this function applied last.

Composes two instances of Function1 in a new Function1, with this function applied last.

Type parameters

A

the type to which function g can be applied

Value parameters

g

a function A => T1

Attributes

Returns

a new function f such that f(x) == apply(g(x))

Inherited from:
Function1
def productElementNames: Iterator[String]

An iterator over the names of all the elements of this product.

An iterator over the names of all the elements of this product.

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

An iterator over all the elements of this product.

An iterator over all the elements of this product.

Attributes

Returns

in the default implementation, an Iterator[Any]

Inherited from:
Product
override def toString(): String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
Function1 -> Any
Inherited from:
Function1
final def ~>[_O, _E >: Either[Throwable, E]](that: Stage[O, _O, _E]): Stage[I, _O, _E]

Composes this stage with that, feeding this stage's output into it. See the ''Composition'' section above for what happens when there is no output to feed.

Composes this stage with that, feeding this stage's output into it. See the ''Composition'' section above for what happens when there is no output to feed.

Attributes

Inherited from:
Stage