root
API
Generated with
root/org.sigilaris/org.sigilaris.core/org.sigilaris.core.failure

org.sigilaris.core.failure

package org.sigilaris.core.failure

Members list

Type members

Classlikes

object ClientFailureMessage

Factory for structured client-facing failure messages.

Factory for structured client-facing failure messages.

Encodes failure information into a standardized string format using FailureMessageFormat, categorized by client failure kind (invalid request, forbidden, not found).

Attributes

Source
ClientFailureMessage.scala
Supertypes
class Object
trait Matchable
class Any
Self type
object ConflictMessage

Factory for structured conflict failure messages.

Factory for structured conflict failure messages.

Encodes conflict information (e.g., optimistic concurrency violations) into a standardized string format using FailureMessageFormat.

Attributes

Source
ConflictMessage.scala
Supertypes
class Object
trait Matchable
class Any
Self type
final case class CryptoFailure(msg: String) extends SigilarisFailure

Cryptographic operation failed (e.g., signature verification, key recovery).

Cryptographic operation failed (e.g., signature verification, key recovery).

Value parameters

msg

the crypto operation error description

Attributes

Source
SigilarisFailure.scala
Supertypes
trait Product
trait Equals
trait NoStackTrace
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
final case class DecodeFailure(msg: String) extends SigilarisFailure

Decoding failed with a descriptive message (e.g., type mismatch, missing field).

Decoding failed with a descriptive message (e.g., type mismatch, missing field).

Value parameters

msg

the failure description

Attributes

Source
SigilarisFailure.scala
Supertypes
trait Product
trait Equals
trait NoStackTrace
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
final case class ErrorKey(rendered: String, code: FailureCode)

External mapping key projected from a FailureCode plus formatter context.

External mapping key projected from a FailureCode plus formatter context.

Value parameters

code

the associated failure code

rendered

the validated (or fallback) key string

Attributes

Companion
object
Source
FailureCode.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ErrorKey

Factory for ErrorKey instances with pattern-based validation.

Factory for ErrorKey instances with pattern-based validation.

Attributes

Companion
class
Source
FailureCode.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
ErrorKey.type
object FailureCode

Predefined FailureCode constants for core failure categories.

Predefined FailureCode constants for core failure categories.

Attributes

Source
FailureCode.scala
Supertypes
class Object
trait Matchable
class Any
Self type
final case class FailureDiagnostic(reason: String, detail: Option[String])

Structured diagnostic payload shared by failure and rejection surfaces.

Structured diagnostic payload shared by failure and rejection surfaces.

Attributes

Companion
object
Source
FailureDiagnostic.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object FailureDiagnostic

Companion for FailureDiagnostic.

Companion for FailureDiagnostic.

Attributes

Companion
class
Source
FailureDiagnostic.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
enum FailureDiagnosticFamily

Closed family describing which subsystem emitted a structured diagnostic.

Closed family describing which subsystem emitted a structured diagnostic.

Attributes

Source
FailureDiagnostic.scala
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class FailureMessageEnvelope(errorKey: String, message: Option[String], detail: Option[String])

Parsed or to-be-rendered failure message payload.

Parsed or to-be-rendered failure message payload.

Attributes

Companion
object
Source
FailureMessageEnvelope.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object FailureMessageEnvelope

Companion for FailureMessageEnvelope.

Companion for FailureMessageEnvelope.

Attributes

Companion
class
Source
FailureMessageEnvelope.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class ParseFailure(msg: String) extends SigilarisFailure

Parsing of external representation (e.g., JSON text) failed.

Parsing of external representation (e.g., JSON text) failed.

Value parameters

msg

the parse error description

Attributes

Source
SigilarisFailure.scala
Supertypes
trait Product
trait Equals
trait NoStackTrace
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
final case class RoutingFailure(msg: String) extends SigilarisFailure

Transaction routing failed (e.g., module not found in composed blueprint).

Transaction routing failed (e.g., module not found in composed blueprint).

Value parameters

msg

the routing error description

Attributes

Source
SigilarisFailure.scala
Supertypes
trait Product
trait Equals
trait NoStackTrace
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
sealed trait SigilarisFailure extends NoStackTrace

Base failure type for Sigilaris operations.

Base failure type for Sigilaris operations.

All failures carry a human-readable message and avoid stack traces for performance and clarity in error reporting.

Attributes

Companion
object
Source
SigilarisFailure.scala
Supertypes
trait NoStackTrace
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
Known subtypes
class ParseFailure
class TrieFailure
Show all
object SigilarisFailure

Attributes

Companion
trait
Source
SigilarisFailure.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
trait StructuredFailureDiagnostic

Shared surface for failures that expose machine-readable reason/detail data.

Shared surface for failures that expose machine-readable reason/detail data.

Attributes

Source
FailureDiagnostic.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class StaleCursor
Show all
final case class TrieFailure(msg: String) extends SigilarisFailure

Merkle trie operation failed (e.g., node store access, structural issues).

Merkle trie operation failed (e.g., node store access, structural issues).

Value parameters

msg

the trie operation error description

Attributes

Source
SigilarisFailure.scala
Supertypes
trait Product
trait Equals
trait NoStackTrace
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
sealed trait UInt256Failure extends SigilarisFailure

Sealed family of failures specific to UInt256 operations.

Sealed family of failures specific to UInt256 operations.

Must live in this file alongside SigilarisFailure to satisfy the sealed restriction.

Attributes

Source
SigilarisFailure.scala
Supertypes
trait NoStackTrace
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
Known subtypes
final case class UInt256InvalidHex(detail: String) extends UInt256Failure

The input hex string contains characters that are not valid hexadecimal digits.

The input hex string contains characters that are not valid hexadecimal digits.

Value parameters

detail

description of the hex parsing error

Attributes

Source
SigilarisFailure.scala
Supertypes
trait Product
trait Equals
trait NoStackTrace
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
case object UInt256NegativeValue extends UInt256Failure

The input value is negative, which is invalid for an unsigned 256-bit integer.

The input value is negative, which is invalid for an unsigned 256-bit integer.

Attributes

Source
SigilarisFailure.scala
Supertypes
trait Singleton
trait Product
trait Mirror
trait Product
trait Equals
trait NoStackTrace
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class UInt256Overflow(detail: String) extends UInt256Failure

The input value exceeds the 2^256 - 1 upper bound.

The input value exceeds the 2^256 - 1 upper bound.

Value parameters

detail

description of the overflow condition

Attributes

Source
SigilarisFailure.scala
Supertypes
trait Product
trait Equals
trait NoStackTrace
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
final case class UInt256TooLong(actualBytes: Long, maxBytes: Int) extends UInt256Failure

Input byte sequence exceeds the maximum allowed length for UInt256.

Input byte sequence exceeds the maximum allowed length for UInt256.

Value parameters

actualBytes

the actual number of bytes provided

maxBytes

the maximum allowed number of bytes (32)

Attributes

Source
SigilarisFailure.scala
Supertypes
trait Product
trait Equals
trait NoStackTrace
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all

Types

opaque type FailureCode

Stable, transport-neutral identifier for a failure source.

Stable, transport-neutral identifier for a failure source.

Values must match the pattern [a-z0-9]+([._-][a-z0-9]+)*.

Value parameters

value

the dot/dash/underscore-separated identifier string

Attributes

Source
FailureCode.scala
Generated with