Struct RoleCostCap 

pub struct RoleCostCap { /* private fields */ }

Cost cap of an agent role over a calendar period.

Examples

use ironflow_core::agent_role::{CostPeriod, RoleCostCap};
use rust_decimal::Decimal;

let cap = RoleCostCap::per_month(Decimal::new(50, 0));
assert_eq!(cap.limit_usd(), Decimal::new(50, 0));
assert_eq!(cap.period(), CostPeriod::Month);

Implementations

impl RoleCostCap

pub fn per_day(limit_usd: Decimal) -> RoleCostCap

Cap of limit_usd per calendar day (UTC). Zero disables the role.

Examples

use ironflow_core::agent_role::{CostPeriod, RoleCostCap};
use rust_decimal::Decimal;

assert_eq!(RoleCostCap::per_day(Decimal::ONE).period(), CostPeriod::Day);

Panics

Panics if limit_usd is negative.

pub fn per_month(limit_usd: Decimal) -> RoleCostCap

Cap of limit_usd per calendar month (UTC). Zero disables the role.

Examples

use ironflow_core::agent_role::{CostPeriod, RoleCostCap};
use rust_decimal::Decimal;

assert_eq!(RoleCostCap::per_month(Decimal::ONE).period(), CostPeriod::Month);

Panics

Panics if limit_usd is negative.

pub fn limit_usd(&self) -> Decimal

The cap, in USD.

Examples

use ironflow_core::agent_role::RoleCostCap;
use rust_decimal::Decimal;

assert_eq!(RoleCostCap::per_day(Decimal::TWO).limit_usd(), Decimal::TWO);

pub fn period(&self) -> CostPeriod

The period the cap applies to.

Examples

use ironflow_core::agent_role::{CostPeriod, RoleCostCap};
use rust_decimal::Decimal;

assert_eq!(RoleCostCap::per_day(Decimal::TWO).period(), CostPeriod::Day);

Trait Implementations

impl Clone for RoleCostCap

fn clone(&self) -> RoleCostCap

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for RoleCostCap

impl Debug for RoleCostCap

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

Formats the value using the given formatter.

impl Eq for RoleCostCap

impl PartialEq for RoleCostCap

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for RoleCostCap