Skip to main content

BudgetConfig

Struct BudgetConfig 

Source
pub struct BudgetConfig {
    pub default_run_max_cost_usd: Option<Decimal>,
    pub monthly_cost_limit_usd: Option<Decimal>,
}
Expand description

Server-level cost guardrails.

Both fields default to None, which disables the corresponding check and preserves the pre-existing behaviour exactly.

§Examples

use ironflow_engine::budget::BudgetConfig;

let config = BudgetConfig::new();
assert!(config.default_run_max_cost_usd.is_none());
assert!(config.monthly_cost_limit_usd.is_none());

Fields§

§default_run_max_cost_usd: Option<Decimal>

Default cost cap applied to a run when neither the creation request nor the handler declares one. None means no default cap.

§monthly_cost_limit_usd: Option<Decimal>

Global quota for the current calendar month (UTC). None disables the monthly check.

Implementations§

Source§

impl BudgetConfig

Source

pub fn new() -> Self

Create a configuration with both guardrails disabled.

§Examples
use ironflow_engine::budget::BudgetConfig;

assert_eq!(BudgetConfig::new(), BudgetConfig::default());
Source

pub fn default_run_max_cost_usd(self, cap: Decimal) -> Self

Set the server-wide default per-run cost cap.

§Examples
use ironflow_engine::budget::BudgetConfig;
use rust_decimal::Decimal;

let config = BudgetConfig::new().default_run_max_cost_usd(Decimal::new(150, 2));
assert_eq!(config.default_run_max_cost_usd, Some(Decimal::new(150, 2)));
Source

pub fn monthly_cost_limit_usd(self, limit: Decimal) -> Self

Set the global monthly cost quota.

§Examples
use ironflow_engine::budget::BudgetConfig;
use rust_decimal::Decimal;

let config = BudgetConfig::new().monthly_cost_limit_usd(Decimal::new(10000, 2));
assert_eq!(config.monthly_cost_limit_usd, Some(Decimal::new(10000, 2)));
Source

pub fn from_env() -> Self

Load the configuration from the environment.

Reads DEFAULT_RUN_MAX_COST_ENV and MONTHLY_COST_LIMIT_ENV. A variable that is unset, empty, unparseable, or negative is ignored (the corresponding guardrail stays disabled) and logged at WARN. Loading never fails, so a malformed value can never prevent the server from starting.

§Examples
use ironflow_engine::budget::BudgetConfig;

let config = BudgetConfig::from_env();
Source

pub fn resolve_run_cap( &self, requested: Option<Decimal>, handler_default: Option<Decimal>, ) -> Option<Decimal>

Resolve the cost cap of a run being created.

Priority, strongest first: the value supplied at creation time, then the handler default, then the server default. None at every level means the run has no cap.

§Examples
use ironflow_engine::budget::BudgetConfig;
use rust_decimal::Decimal;

let server = Decimal::new(100, 2);
let handler = Decimal::new(200, 2);
let requested = Decimal::new(300, 2);
let config = BudgetConfig::new().default_run_max_cost_usd(server);

assert_eq!(config.resolve_run_cap(Some(requested), Some(handler)), Some(requested));
assert_eq!(config.resolve_run_cap(None, Some(handler)), Some(handler));
assert_eq!(config.resolve_run_cap(None, None), Some(server));

Trait Implementations§

Source§

impl Clone for BudgetConfig

Source§

fn clone(&self) -> BudgetConfig

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 BudgetConfig

Source§

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

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

impl Default for BudgetConfig

Source§

fn default() -> BudgetConfig

Returns the “default value” for a type. Read more
Source§

impl Eq for BudgetConfig

Source§

impl PartialEq for BudgetConfig

Source§

fn eq(&self, other: &BudgetConfig) -> 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 BudgetConfig

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> DynClone for T
where T: Clone,

Source§

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

Source§

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

Source§

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

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

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

Source§

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.

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> PolicyExt for T
where T: ?Sized,

Source§

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

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

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = !

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

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

Source§

fn vzip(self) -> V

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