Struct GrateLimiter 

pub struct GrateLimiter { /* private fields */ }

The main grate-limiter engine.

Thread-safe and cheaply cloneable. All instances share the same internal state.

Example

use grate_limiter::{GrateLimiter, EngineConfig};

let engine = GrateLimiter::new(EngineConfig::default());
// Register providers and capabilities, then use engine.select() and engine.observe()

Implementations

impl GrateLimiter

pub fn new(config: EngineConfig) -> Self

Create a new engine with the given configuration.

pub fn upsert_provider(&self, config: ProviderConfig)

Register or update a provider and its quotas.

If the provider already exists, its configuration and quota trackers are replaced. Health state is preserved across upserts.

pub fn upsert_capability(&self, config: CapabilityConfig)

Register or update a capability and its provider mappings.

pub fn select(&self, capability: &str) -> Result<Decision>

Select the best provider for a capability.

Returns a Decision with the selected provider, its score, reasoning breakdown, and ranked alternatives.

Errors

• Error::UnknownCapability if the capability is not registered.
• Error::NoAvailableProviders if all providers are in cooldown or below minimum health.

pub fn observe(&self, obs: Observation) -> Result<()>

Report an observation after a provider interaction.

Updates quota counters and health state for the provider.

Errors

• Error::UnknownProvider if the provider is not registered.

pub fn metrics(&self) -> &Metrics

Access engine metrics.

pub fn provider_health(&self, provider: &str) -> Option<f32>

Get the current health score for a provider.

pub fn provider_in_cooldown(&self, provider: &str) -> Option<bool>

Check if a provider is currently in cooldown.

pub fn provider_quota_remaining( &self, provider: &str, dimension: Dimension, ) -> Option<u64>

Get the remaining quota for a specific dimension on a provider.

Trait Implementations

impl Clone for GrateLimiter

fn clone(&self) -> GrateLimiter

Returns a duplicate of the value.

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

Performs copy-assignment from source.