Skip to main content

StructuralGate

Struct StructuralGate 

Source
pub struct StructuralGate {
    pub applies_to: GateScope,
    pub condition: &'static str,
    pub blocked_status: &'static str,
    pub reason: &'static str,
    pub severity: GateSeverity,
}
Expand description

One human-actionable structural gate: a condition type, the status that means BLOCKED, the reason the writer stamps, the CR kinds it appears on, and how loudly to report it.

Polarity is per-row rather than implied, because kopiur has gates of both shapes: MoverPermitted=False blocks, and so does DeletionHeld=True.

Fields§

§applies_to: GateScope

The CR kinds this gate’s condition is written on.

§condition: &'static str

The condition type (a consts string, never a literal at the call site).

§blocked_status: &'static str

The condition status that means BLOCKED — CONDITION_FALSE or CONDITION_TRUE.

§reason: &'static str

The reason the reconciler stamps when it writes the blocked condition.

§severity: GateSeverity

How loudly a tripped gate is reported.

Implementations§

Source§

impl StructuralGate

Source

pub fn matches(&self, condition_type: &str, status: &str, reason: &str) -> bool

Whether a live condition is this gate: type, status, AND reason all match.

This is the matcher consumers should reach for. condition + status alone do not identify a row — CredentialsAvailable=False is written with several different reasons and therefore has several rows — so filtering the registry on trips alone yields multiple hits for one live condition and double-reports it. matches selects exactly one row per live condition, which is the property gate_rows_are_unique_and_internally_consistent pins.

use kopiur_api::gates::STRUCTURAL_GATES;

// One live condition off a wedged Snapshot ⇒ exactly one registry row.
let hits: Vec<_> = STRUCTURAL_GATES
    .iter()
    .filter(|g| g.matches("CredentialsAvailable", "False", "MissingCredentialsSecret"))
    .collect();
assert_eq!(hits.len(), 1);
assert_eq!(hits[0].reason, "MissingCredentialsSecret");
// The other reason selects the other row, never both.
assert!(!hits[0].matches("CredentialsAvailable", "False", "MissingServiceAccount"));
Source

pub fn trips(&self, condition_type: &str, status: &str) -> bool

The reason-agnostic coarse filter: whether a live condition’s type/status pair is the blocked polarity of this gate’s condition.

The polarity comparison lives here so no consumer re-derives it (the != "True" / == "True" mix-ups this registry exists to prevent). Use it to answer “is this condition one of the ones we gate on at all?” — notably when a live condition carries a reason NO row covers (a newer operator’s reason string), where matches would silently report nothing. To identify WHICH row a condition is, use matches: trips can match several rows sharing a condition+polarity.

use kopiur_api::gates::{STRUCTURAL_GATES, GateScope};

let mover = STRUCTURAL_GATES
    .iter()
    .find(|g| g.condition == "MoverPermitted")
    .expect("the privileged-mover gate is registered");
assert!(mover.trips("MoverPermitted", "False"));
assert!(!mover.trips("MoverPermitted", "True"));
assert!(!mover.trips("Ready", "False"));
assert_eq!(mover.applies_to, GateScope::SnapshotOrRestore);

// Coarse by design: an unregistered reason still flags the condition.
assert!(mover.trips("MoverPermitted", "False"));
Source

pub fn blocked_is_true(&self) -> bool

blocked_status as the bool a condition writer passes when it writes this gate as BLOCKED — true for CONDITION_TRUE, false for CONDITION_FALSE.

The controller’s upsert_condition takes a bool, so without this every registry-driven writer would hand-translate the status string at its own call site — exactly the per-site re-derivation this registry exists to remove. Any other string reads as false; the every_gate_row_is_well_formed tripwire makes that unreachable.

use kopiur_api::gates::STRUCTURAL_GATES;

let mover = STRUCTURAL_GATES
    .iter()
    .find(|g| g.condition == "MoverPermitted")
    .expect("registered");
assert!(!mover.blocked_is_true()); // MoverPermitted=False blocks

let held = STRUCTURAL_GATES
    .iter()
    .find(|g| g.condition == "DeletionHeld")
    .expect("registered");
assert!(held.blocked_is_true()); // DeletionHeld=True blocks

Trait Implementations§

Source§

impl Clone for StructuralGate

Source§

fn clone(&self) -> StructuralGate

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for StructuralGate

Source§

impl Debug for StructuralGate

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for StructuralGate

Source§

impl PartialEq for StructuralGate

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for StructuralGate

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> AnyExt for T
where T: Any + ?Sized,

§

fn downcast_ref<T>(this: &Self) -> Option<&T>
where T: Any,

Attempts to downcast this to T behind reference
§

fn downcast_mut<T>(this: &mut Self) -> Option<&mut T>
where T: Any,

Attempts to downcast this to T behind mutable reference
§

fn downcast_rc<T>(this: Rc<Self>) -> Result<Rc<T>, Rc<Self>>
where T: Any,

Attempts to downcast this to T behind Rc pointer
§

fn downcast_arc<T>(this: Arc<Self>) -> Result<Arc<T>, Arc<Self>>
where T: Any,

Attempts to downcast this to T behind Arc pointer
§

fn downcast_box<T>(this: Box<Self>) -> Result<Box<T>, Box<Self>>
where T: Any,

Attempts to downcast this to T behind Box pointer
§

fn downcast_move<T>(this: Self) -> Option<T>
where T: Any, Self: Sized,

Attempts to downcast owned Self to T, useful only in generic context as a workaround for specialization
§

impl<T> AsDebug for T
where T: Debug,

§

fn as_debug(&self) -> &dyn Debug

Returns self as a &dyn Debug trait object.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<T, X> CoerceTo<T> for X
where T: CoerceFrom<X> + ?Sized,

§

fn coerce_rc_to(self: Rc<X>) -> Rc<T>

§

fn coerce_box_to(self: Box<X>) -> Box<T>

§

fn coerce_ref_to(&self) -> &T

§

fn coerce_mut_to(&mut self) -> &mut T

Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T> ServiceExt for T

§

fn map_response_body<F>(self, f: F) -> MapResponseBody<Self, F>
where Self: Sized,

Apply a transformation to the response body. Read more
§

fn trace_for_http(self) -> Trace<Self, SharedClassifier<ServerErrorsAsFailures>>
where Self: Sized,

High level tracing that classifies responses using HTTP status codes. Read more
§

fn trace_for_grpc(self) -> Trace<Self, SharedClassifier<GrpcErrorsAsFailures>>
where Self: Sized,

High level tracing that classifies responses using gRPC headers. Read more
§

fn follow_redirects(self) -> FollowRedirect<Self>
where Self: Sized,

Follow redirect resposes using the Standard policy. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more