Enum GateScope 

pub enum GateScope {
    SnapshotOrRestore,
    Snapshot,
    Repository,
    SnapshotSchedule,
    SnapshotPolicy,
}

Which CR kinds a structural gate’s condition is written on.

Deliberately coarse (kinds, not selectors): a gate row answers “when I look at an object of THIS kind, is this condition meaningful?”, which is all a diagnostic needs to avoid hunting for a condition that can never appear.

use kopiur_api::gates::GateScope;

// A privileged-mover refusal is written on both work kinds.
assert!(GateScope::SnapshotOrRestore.covers_snapshot());
assert!(GateScope::SnapshotOrRestore.covers_restore());
// The mass-deletion breaker's per-Snapshot hold is Snapshot-only.
assert!(GateScope::Snapshot.covers_snapshot());
assert!(!GateScope::Snapshot.covers_restore());
// Repository gates live on Repository/ClusterRepository.
assert!(GateScope::Repository.covers_repository());
assert!(!GateScope::Repository.covers_snapshot());
// A schedule-level block lives on the SnapshotSchedule itself.
assert!(GateScope::SnapshotSchedule.covers_snapshot_schedule());
assert!(!GateScope::Snapshot.covers_snapshot_schedule());
// A recipe-level block lives on the SnapshotPolicy itself.
assert!(GateScope::SnapshotPolicy.covers_snapshot_policy());
assert!(!GateScope::SnapshotPolicy.covers_snapshot());

Variants

SnapshotOrRestore

Written on both Snapshot and Restore CRs (the two “work” kinds that launch mover Jobs, and whose reconcilers share the gate).

Snapshot

Written on Snapshot CRs only.

Repository

Written on Repository and ClusterRepository CRs.

SnapshotSchedule

Written on SnapshotSchedule CRs only — the schedule itself is blocked, as opposed to any individual run being blocked.

SnapshotPolicy

Written on SnapshotPolicy CRs only — the recipe itself is (partially) blocked, as opposed to any individual run being blocked.

Implementations

impl GateScope

pub fn covers_snapshot(self) -> bool

Whether a Snapshot can carry a gate of this scope. Exhaustive.

pub fn covers_restore(self) -> bool

Whether a Restore can carry a gate of this scope. Exhaustive.

pub fn covers_repository(self) -> bool

Whether a Repository/ClusterRepository can carry a gate of this scope. Exhaustive.

pub fn covers_snapshot_schedule(self) -> bool

Whether a SnapshotSchedule can carry a gate of this scope. Exhaustive.

pub fn covers_snapshot_policy(self) -> bool

Whether a SnapshotPolicy can carry a gate of this scope. Exhaustive.

Trait Implementations

impl Clone for GateScope

fn clone(&self) -> GateScope

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for GateScope

impl Debug for GateScope

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for GateScope

impl Hash for GateScope

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for GateScope

fn eq(&self, other: &GateScope) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for GateScope