error

Module: error

Contents

Enums

• StackError - Error type returned by every public operation in this crate.

Type Aliases

• Result - Convenience alias used throughout the crate for Result<T, StackError>.

---

firma_stack::error::Result

Type Alias: std::result::Result<T, StackError>

Convenience alias used throughout the crate for Result<T, StackError>.

firma_stack::error::StackError

Enum

Error type returned by every public operation in this crate.

All variants carry enough context to be rendered as a single-line operator-facing message. Callers should generally print format!("{err}") and exit non-zero rather than introspect variants.

Variants:

• ConfigRead{ path: std::path::PathBuf, source: io::Error } - Reading the stack config file from disk failed.
• ConfigParse{ path: std::path::PathBuf, source: Box<toml::de::Error> } - The stack config file is present but not valid TOML.
• ConfigMissing{ path: std::path::PathBuf, field: &'static str } - A required field is absent from the stack config.
• MarkerParse{ path: std::path::PathBuf, source: Box<toml::de::Error> } - A sidecar marker file (metadata.toml) is present but not valid TOML.
• StateDir(String) - State-dir resolution chain (flag, env, platform default) produced
• StateDirCreate{ path: std::path::PathBuf, source: io::Error } - Creating the state directory on disk failed.
• AlreadyRunning{ path: std::path::PathBuf } - Another supervisor already holds the stack lock for this state dir.
• Spawn{ component: String, source: io::Error } - Spawning a child component (authority or sidecar) failed.
• Readiness{ component: String, timeout_secs: u64 } - A component did not become ready (TCP listen or CA material) within
• Io(io::Error) - Generic I/O error not classified by a more specific variant.
• Platform(String) - OS-level failure surfaced from platform_unix / platform_windows

Trait Implementations:

• From
  • fn from(source: io::Error) -> Self
• Display
  • fn fmt(self: &Self, __formatter: & mut ::core::fmt::Formatter) -> ::core::fmt::Result
• Error
  • fn source(self: &Self) -> ::core::option::Option<&dyn ::thiserror::__private18::Error>
• Debug
  • fn fmt(self: &Self, f: & mut $crate::fmt::Formatter) -> $crate::fmt::Result