readiness
Module: authority_client::readiness
Section titled “Module: authority_client::readiness”Contents
Section titled “Contents”Structs
ReadinessFlag- Writable readiness flag.ReadinessState- Initial stream readiness.ReadinessView- Read-only readiness view for the request hot path.
firma_sidecar::authority_client::readiness::ReadinessFlag
Section titled “firma_sidecar::authority_client::readiness::ReadinessFlag”Struct
Writable readiness flag.
Methods:
fn new(initial: ReadinessState) -> (Self, ReadinessView)- Create a readiness flag and matching read view.fn view(self: &Self) -> ReadinessView- A read-only view for request handling.fn set_revocation_ready(self: &Self, ready: bool)- Mark the revocation stream ready or not ready.fn snapshot(self: &Self) -> ReadinessState- Snapshot of current readiness without subscribing.fn subscribe(self: &Self) -> watch::Receiver<ReadinessState>- Subscribe to readiness changes.fn wait_until_fully_ready(self: &Self)- Resolve once bothpolicy_bundle_readyandrevocation_readyare
firma_sidecar::authority_client::readiness::ReadinessState
Section titled “firma_sidecar::authority_client::readiness::ReadinessState”Struct
Initial stream readiness.
Fields:
policy_bundle_ready: bool- A policy bundle has been applied successfully.policy_bundle_fresh: bool- The enforced policy bundle has not passed its TTL deadline.revocation_ready: bool- The revocation stream has connected and passed its initial barrier.run_rejected: bool- The Authority rejected this Sidecar’s run. Terminal: the bundle never
Methods:
fn fully_ready(self: Self) -> bool- Both streams have hydrated and the sidecar can serve traffic.fn serving(self: Self) -> bool- Both streams have hydrated and the enforced bundle is still fresh, so
Traits: Eq, Copy
Trait Implementations:
- Default
fn default() -> Self
- Debug
fn fmt(self: &Self, f: & mut $crate::fmt::Formatter) -> $crate::fmt::Result
- PartialEq
fn eq(self: &Self, other: &Self) -> bool
- Clone
fn clone(self: &Self) -> Self
firma_sidecar::authority_client::readiness::ReadinessView
Section titled “firma_sidecar::authority_client::readiness::ReadinessView”Struct
Read-only readiness view for the request hot path.
Trait Implementations:
- Clone
fn clone(self: &Self) -> Self