Skip to main content

RateLimitingMiddleware

Struct RateLimitingMiddleware 

Source
pub struct RateLimitingMiddleware { /* private fields */ }
Expand description

Rate limiting middleware using token bucket algorithm.

Uses a token bucket algorithm by default, allowing for burst traffic while maintaining a sustainable long-term rate.

§Example

use fastmcp_server::rate_limiting::RateLimitingMiddleware;

// Allow 10 requests per second with bursts up to 20
let rate_limiter = RateLimitingMiddleware::new(10.0)
    .burst_capacity(20);

Implementations§

Source§

impl RateLimitingMiddleware

Source

pub fn new(max_requests_per_second: f64) -> Self

Creates a new rate limiting middleware with the specified rate.

§Arguments
  • max_requests_per_second - Sustained requests per second allowed

Burst capacity defaults to 2x the sustained rate.

Source

pub fn burst_capacity(self, capacity: usize) -> Self

Sets the burst capacity (maximum tokens in the bucket).

Source

pub fn client_id_extractor<F>(self, extractor: F) -> Self
where F: Fn(&McpContext, &JsonRpcRequest) -> Option<String> + Send + Sync + 'static,

Sets a custom function to extract client ID from the request context.

If not set, all clients share a single rate limit (global limiting).

Source

pub fn global(self) -> Self

Enables global rate limiting (all clients share one limit).

When enabled, all requests count against a single rate limit regardless of client identity.

Trait Implementations§

Source§

impl Debug for RateLimitingMiddleware

Source§

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

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

impl Middleware for RateLimitingMiddleware

Source§

fn on_request( &self, ctx: &McpContext, request: &JsonRpcRequest, ) -> McpResult<MiddlewareDecision>

Invoked before routing the request. Read more
Source§

fn on_response( &self, _ctx: &McpContext, _request: &JsonRpcRequest, response: Value, ) -> McpResult<Value>

Invoked after a successful handler result is produced. Read more
Source§

fn on_error( &self, _ctx: &McpContext, _request: &JsonRpcRequest, error: McpError, ) -> McpError

Invoked when a handler or middleware returns an error. Read more

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> 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: NoopSpan) -> Self

Instruments this future with a span (no-op when disabled).
Source§

fn in_current_span(self) -> Self

Instruments this future with the current span (no-op when disabled).
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> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = Infallible

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