Skip to main content

ForgeError

forge_guardrails::error

Enum ForgeError

pub enum ForgeError {
Show 13 variants
    UnsupportedModel(UnsupportedModelError),
    ToolCall(ToolCallError),
    ToolExecution(ToolExecutionError),
    WorkflowCancelled(WorkflowCancelledError),
    MaxIterations(MaxIterationsError),
    StepEnforcement(StepEnforcementError),
    Prerequisite(PrerequisiteError),
    ContextBudgetExceeded(ContextBudgetExceeded),
    HardwareDetection(HardwareDetectionError),
    ContextDiscovery(ContextDiscoveryError),
    BudgetResolution(BudgetResolutionError),
    Backend(BackendError),
    Stream(StreamError),
}

Expand description

Base error type for the forge-guardrails framework.

All framework errors except ToolResolutionError are represented as variants of this enum, preserving catch-as-base semantics.

Variants§

UnsupportedModel(UnsupportedModelError)

The model is not supported.

ToolCall(ToolCallError)

Failed to parse/construct a tool call.

ToolExecution(ToolExecutionError)

Tool execution failed.

WorkflowCancelled(WorkflowCancelledError)

Workflow cancelled.

MaxIterations(MaxIterationsError)

Max iterations reached.

StepEnforcement(StepEnforcementError)

Premature terminal tool call step violation.

Prerequisite(PrerequisiteError)

Prerequisite step check failed.

ContextBudgetExceeded(ContextBudgetExceeded)

Context budget tokens exceeded.

HardwareDetection(HardwareDetectionError)

Hardware detection failed.

ContextDiscovery(ContextDiscoveryError)

Context length discovery failed.

BudgetResolution(BudgetResolutionError)

Budget resolution failed.

Backend(BackendError)

Backend request failed.

Stream(StreamError)

Stream error.

Trait Implementations§

impl Debug for ForgeError

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

Formats the value using the given formatter. Read more

impl Display for ForgeError

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

Formats the value using the given formatter. Read more

impl Error for ForgeError

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

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

impl From<BackendError> for ForgeError

fn from(source: BackendError) -> Self

Converts to this type from the input type.

impl From<BudgetResolutionError> for ForgeError

fn from(source: BudgetResolutionError) -> Self

Converts to this type from the input type.

impl From<ContextBudgetExceeded> for ForgeError

fn from(source: ContextBudgetExceeded) -> Self

Converts to this type from the input type.

impl From<ContextDiscoveryError> for ForgeError

fn from(source: ContextDiscoveryError) -> Self

Converts to this type from the input type.

impl From<HardwareDetectionError> for ForgeError

fn from(source: HardwareDetectionError) -> Self

Converts to this type from the input type.

impl From<MaxIterationsError> for ForgeError

fn from(source: MaxIterationsError) -> Self

Converts to this type from the input type.

impl From<PrerequisiteError> for ForgeError

fn from(source: PrerequisiteError) -> Self

Converts to this type from the input type.

impl From<StepEnforcementError> for ForgeError

fn from(source: StepEnforcementError) -> Self

Converts to this type from the input type.

impl From<StreamError> for ForgeError

fn from(source: StreamError) -> Self

Converts to this type from the input type.

impl From<ToolCallError> for ForgeError

fn from(source: ToolCallError) -> Self

Converts to this type from the input type.

impl From<ToolExecutionError> for ForgeError

fn from(source: ToolExecutionError) -> Self

Converts to this type from the input type.

impl From<UnsupportedModelError> for ForgeError

fn from(source: UnsupportedModelError) -> Self

Converts to this type from the input type.

impl From<WorkflowCancelledError> for ForgeError

fn from(source: WorkflowCancelledError) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

impl Freeze for ForgeError

impl RefUnwindSafe for ForgeError

impl Send for ForgeError

impl Sync for ForgeError

impl Unpin for ForgeError

impl UnsafeUnpin for ForgeError

impl UnwindSafe for ForgeError

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

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

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> IntoEither for T

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

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<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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> Same for T

type Output = T

Should always be Self

impl<T> ToString for T
where T: Display + ?Sized,

fn to_string(&self) -> String

Converts the given value to a String. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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