Skip to content

readiness

Structs


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 set_policy_bundle_ready(self: &Self, ready: bool) - Mark the policy bundle stream ready or not ready.
  • 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 wait_until_fully_ready(self: &Self) - Resolve once both policy_bundle_ready and revocation_ready are

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.
  • revocation_ready: bool - The revocation stream has connected and passed its initial barrier.

Methods:

  • fn fully_ready(self: Self) -> bool - Both streams have hydrated and the sidecar can serve traffic.

Traits: Copy, Eq

Trait Implementations:

  • Debug
    • fn fmt(self: &Self, f: & mut $crate::fmt::Formatter) -> $crate::fmt::Result
  • Clone
    • fn clone(self: &Self) -> ReadinessState
  • Default
    • fn default() -> ReadinessState
  • PartialEq
    • fn eq(self: &Self, other: &ReadinessState) -> bool

firma_sidecar::authority_client::readiness::ReadinessView

Section titled “firma_sidecar::authority_client::readiness::ReadinessView”

Struct

Read-only readiness view for the request hot path.

Methods:

  • fn snapshot(self: &Self) -> ReadinessState - Return a lock-free snapshot of current readiness.
  • fn all_ready() -> Self - Construct a view that is already fully ready.

Trait Implementations:

  • Clone
    • fn clone(self: &Self) -> ReadinessView