Struct Limits 

pub struct Limits {
    pub requests_per_minute: u32,
    pub sign_ins_per_minute: u32,
    pub body_bytes: usize,
    pub characters: u32,
    pub monsters: u32,
    pub rules_texts: u32,
    pub combats: u32,
    pub plans: u32,
    pub devices: u32,
    pub events_per_combat: u32,
    pub connections_per_combat: u32,
    pub trust_proxy: bool,
    /* private fields */
}

What a service allows; see the module’s description.

Fields

requests_per_minute: u32

Requests per minute from one client address, to any route.

sign_ins_per_minute: u32

Requests per minute from one client address to the routes that need no token: logging in, setting up a campaign, joining a pairing.

body_bytes: usize

The largest request body accepted.

characters: u32

What one campaign may keep.

monsters: u32

Its own monsters, and its own spells and its own conditions (each).

rules_texts: u32

combats: u32

plans: u32

devices: u32

events_per_combat: u32

connections_per_combat: u32

Devices watching one combat at once (per instance).

trust_proxy: bool

Whether a request’s client is the last X-Forwarded-For address (TRUST_PROXY=1); see the module’s description.

Implementations

impl Limits

pub fn off() -> Self

No limits at all.

pub fn on() -> Self

The limits a service open to others starts with.

pub fn from_env() -> Result<Self, String>

The limits from the environment: on unless LIMITS=off, each changed by LIMIT_<NAME>, and TRUST_PROXY.

pub fn enabled(&self) -> bool

Whether the limits are on (LIMITS isn’t off).

pub fn room_for( &self, used: i64, more: u32, max: u32, what: &str, ) -> Result<(), String>

Whether a campaign that keeps used of something may add more, given its limit max; if not, what to tell it.

pub fn with(&self, quotas: &Quotas) -> Limits

These, with a campaign’s own quotas in place of the ones they set.

pub fn guard_sign_ins<S: Clone + Send + Sync + 'static>( &self, router: Router<S>, ) -> Router<S>

router (the routes that need no token) with the stricter limit on signing in.

Trait Implementations

impl Clone for Limits

fn clone(&self) -> Limits

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Limits

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

Formats the value using the given formatter.

impl Default for Limits

fn default() -> Self

No limits at all: what tests, and a service on your own machine, want. A service reads its own with Limits::from_env.