Skip to content
beryl logoberyl

beryl/error

Shared beryl-owned error helpers.

Types

Section titled “Types”

CallError

Section titled “CallError”
pub type CallError {
  CallUnavailable
  CallDown(reason: process.ExitReason)
  CallTimedOut
}

A synchronous actor call could not obtain a reply.

OperationFailure

Section titled “OperationFailure”
pub type OperationFailure

An underlying native operation failure, retained without lossy conversion.

Only native operation boundaries construct this value. Format it on demand with describe_operation_failure; the original reason remains intact.

StartFailure

Section titled “StartFailure”
pub type StartFailure

A stable description of an internal beryl actor startup failure.

This type hides OTP's actor.StartError so public APIs do not expose dependency-specific error constructors.

Functions

Section titled “Functions”

describe_call_error

Section titled “describe_call_error”
pub fn describe_call_error(CallError) -> String

Describe an actor-call failure, including its original exit reason.

describe_operation_failure

Section titled “describe_operation_failure”
pub fn describe_operation_failure(OperationFailure) -> String

Describe a native failure with bounded nesting and output length.

describe_start_failure

Section titled “describe_start_failure”
pub fn describe_start_failure(StartFailure) -> String

Return a human-readable description of a startup failure.

Abnormal exits retain their underlying reason internally. Their description includes a depth- and length-limited rendering so large exit terms cannot produce unbounded diagnostic output.

from_actor_start_error

Section titled “from_actor_start_error”
pub fn from_actor_start_error(actor.StartError) -> StartFailure

Convert a gleam/otp/actor.StartError to beryl's StartFailure.