Skip to main content

GuardError

Enum GuardError 

Source
#[non_exhaustive]
pub enum GuardError { Timeout, DeadlineViolated, Panicked(String), Internal(String), Dependency(String), }
Expand description

Something went wrong while evaluating a guard.

A GuardError means the guard did not decide — it is not a decision to block. Conflating “the check failed” with “the check says no” is how a broken dependency becomes a silent hole. Blocking is Verdict::Block; failing is this, resolved by the guard’s own FailPolicy.

#[non_exhaustive]: match with a wildcard arm, since new failure modes may arrive in a minor release.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Timeout

The guard did not finish within its declared Guard::timeout.

For a non-strict guard this is best-effort: the pipeline stops waiting, but the work may still be running. See docs/RELIABILITY.md.

§

DeadlineViolated

A strict guard blew through its deadline.

Unlike GuardError::Timeout, this reports a contract violation: a Guard::strict guard promised to consult the deadline and return on its own. Produced by the pipeline, not by guard authors.

§

Panicked(String)

The guard panicked and the pipeline caught it. Carries the panic message where one could be recovered.

Produced by the pipeline, not by guard authors — deliberate failures should be GuardError::Internal.

§

Internal(String)

The guard’s own logic failed: a malformed rule, an impossible state, a config error found at check time.

§

Dependency(String)

Something the guard relies on failed: a datastore, a model endpoint.

Separate from GuardError::Internal because the operational response differs — a bug in the guard versus an outage elsewhere — and because this is the variant worth retrying.

Implementations§

Source§

impl GuardError

Source

pub fn panicked(message: impl Into<String>) -> Self

Builds a GuardError::Panicked from anything string-like.

Prefer letting the pipeline produce this. Guard authors should return GuardError::Internal for deliberate failures.

Source

pub fn internal(message: impl Into<String>) -> Self

Builds a GuardError::Internal from anything string-like.

Source

pub fn dependency(message: impl Into<String>) -> Self

Builds a GuardError::Dependency from anything string-like.

Source

pub fn is_timeout(&self) -> bool

Returns true for both the soft (GuardError::Timeout) and hard (GuardError::DeadlineViolated) time failures.

Source

pub fn is_panic(&self) -> bool

Returns true if this failure came from a caught panic.

Source

pub fn kind(&self) -> &'static str

A short, stable label for metrics and log fields.

Unlike Display, it never includes the message payload, so it is safe as a bounded-cardinality key.

Source

pub fn message(&self) -> Option<&str>

The message carried by this error, if it has one.

Trait Implementations§

Source§

impl Clone for GuardError

Source§

fn clone(&self) -> Self

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 Debug for GuardError

Source§

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

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

impl Display for GuardError

Source§

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

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

impl Eq for GuardError

Source§

impl Error for GuardError

1.30.0 · Source§

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type-based access to context intended for error reports. Read more
Source§

impl Hash for GuardError

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for GuardError

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for GuardError

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
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
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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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> 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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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