status

Module: status

Contents

Structs

• ComponentStatus - Snapshot of one component’s runtime state.
• StackStatus - Aggregate stack snapshot returned by [status].

Functions

• status - Return current stack status.

---

firma_stack::status::ComponentStatus

Struct

Snapshot of one component’s runtime state.

Fields:

• name: String - Logical component name (authority / sidecar).
• pid: Option<firma_runtime_state::UserProcessId> - PID read from <state_dir>/<name>.pid, when present.
• state: State - Coarse-grained state. See [State].
• listen: Option<std::net::SocketAddr> - Listen address read from <state_dir>/<name>.listen (written at
• uptime_secs: Option<u64> - Seconds since the pidfile was written, used as a proxy for process

Trait Implementations:

• Debug
  • fn fmt(self: &Self, f: & mut $crate::fmt::Formatter) -> $crate::fmt::Result
• Serialize
  • fn serialize<__S>(self: &Self, __serializer: __S) -> _serde::__private228::Result<<__S as >::Ok, <__S as >::Error>
• Clone
  • fn clone(self: &Self) -> ComponentStatus

firma_stack::status::StackStatus

Struct

Aggregate stack snapshot returned by [status].

Fields:

• components: Vec<ComponentStatus> - One entry per known component (authority first, then sidecar).

Trait Implementations:

• Serialize
  • fn serialize<__S>(self: &Self, __serializer: __S) -> _serde::__private228::Result<<__S as >::Ok, <__S as >::Error>
• Clone
  • fn clone(self: &Self) -> StackStatus
• Debug
  • fn fmt(self: &Self, f: & mut $crate::fmt::Formatter) -> $crate::fmt::Result

firma_stack::status::status

Function

Return current stack status.

Errors

Currently returns no error, but keeps a fallible API for future probes.

fn status(state_dir: &std::path::Path) -> crate::error::Result<StackStatus>