Skip to main content

RateLimiterConfig

arete_server::websocket::rate_limiter

Struct RateLimiterConfig

pub struct RateLimiterConfig {
    pub handshake_per_ip: RateLimitWindow,
    pub connections_per_consumer: RateLimitWindow,
    pub connections_per_account: RateLimitWindow,
    pub subscriptions_per_connection: RateLimitWindow,
    pub messages_per_connection: RateLimitWindow,
    pub snapshots_per_connection: RateLimitWindow,
    pub enabled: bool,
}

Expand description

Rate limiter configuration per key type

Fields§

§handshake_per_ip: RateLimitWindow

Rate limit for handshake attempts per IP

§connections_per_consumer: RateLimitWindow

Rate limit for connection attempts per resolved consumer (falls back to the token subject for legacy tokens)

§connections_per_account: RateLimitWindow

Rate limit for connection attempts per resolved account (falls back to the metering key for legacy tokens)

§subscriptions_per_connection: RateLimitWindow

Rate limit for subscription requests per connection

§messages_per_connection: RateLimitWindow

Rate limit for messages per connection

§snapshots_per_connection: RateLimitWindow

Rate limit for snapshot requests per connection

§enabled: bool

Enable rate limiting (can be disabled for testing)

Implementations§

impl RateLimiterConfig

pub fn from_env() -> Self

Load configuration from environment variables

pub fn disabled() -> Self

Disable rate limiting (useful for testing)

Trait Implementations§

impl Clone for RateLimiterConfig

fn clone(&self) -> Self

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

impl Debug for RateLimiterConfig

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

Formats the value using the given formatter. Read more

impl Default for RateLimiterConfig

fn default() -> Self

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

Auto Trait Implementations§

impl Freeze for RateLimiterConfig

impl RefUnwindSafe for RateLimiterConfig

impl Send for RateLimiterConfig

impl Sync for RateLimiterConfig

impl Unpin for RateLimiterConfig

impl UnsafeUnpin for RateLimiterConfig

impl UnwindSafe for RateLimiterConfig

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> PolicyExt for T
where T: ?Sized,

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

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

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

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

type Error = !

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, !>

Performs the conversion.

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

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

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

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more