Struct UsageLimits 

pub struct UsageLimits {
    pub request_limit: Option<u64>,
    pub input_tokens_limit: Option<u64>,
    pub output_tokens_limit: Option<u64>,
    pub total_tokens_limit: Option<u64>,
    pub tool_calls_limit: Option<u64>,
}

Runtime usage limits for one agent run.

Fields

request_limit: Option<u64>

Maximum provider requests allowed in one run.

input_tokens_limit: Option<u64>

Maximum input tokens allowed.

output_tokens_limit: Option<u64>

Maximum output tokens allowed.

total_tokens_limit: Option<u64>

Maximum total tokens allowed.

tool_calls_limit: Option<u64>

Maximum successful function tool calls allowed.

Implementations

impl UsageLimits

pub const fn new() -> Self

Create empty limits.

pub const fn with_request_limit(self, limit: u64) -> Self

Set request limit.

pub const fn with_input_tokens_limit(self, limit: u64) -> Self

Set input token limit.

pub const fn with_output_tokens_limit(self, limit: u64) -> Self

Set output token limit.

pub const fn with_total_tokens_limit(self, limit: u64) -> Self

Set total token limit.

pub const fn with_tool_calls_limit(self, limit: u64) -> Self

Set successful tool-call limit.

pub const fn check_before_request( &self, current: &Usage, ) -> Result<(), UsageLimitError>

Check whether the next model request would exceed the request limit.

Errors

Returns an error when another request would exceed the configured request limit.

pub const fn check_tool_calls( &self, projected: &Usage, ) -> Result<(), UsageLimitError>

Check whether projected tool calls would exceed the tool-call limit.

Errors

Returns an error when executing the next successful tool calls would exceed the configured limit.

pub fn check_usage(&self, usage: &Usage) -> Result<(), UsageLimitError>

Check whether accumulated usage exceeds configured token or pricing limits.

Errors

Returns an error when accumulated usage exceeds any configured limit.

Trait Implementations

impl Clone for UsageLimits

fn clone(&self) -> UsageLimits

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UsageLimits

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

Formats the value using the given formatter.

impl Default for UsageLimits

fn default() -> UsageLimits

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for UsageLimits

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for UsageLimits

impl PartialEq for UsageLimits

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for UsageLimits

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for UsageLimits