Struct rocket_governor::LimitHeaderGen

pub struct LimitHeaderGen;

Provides Fairing implementation which is attachable to Rocket-instance.

LimitHeaderGen generates HTTP headers in Reponses to Requests at specific mounted routes.

The Route needs a RocketGovernor guard. The guard is responsible for managing the governor rate limit.

Depending on the implementation of RocketGovernable::limit_info_allow(), LimitHeaderGen fairing sets HTTP headers like

• X_RATELIMIT_LIMIT
• X_RATELIMIT_REMAINING

which can be used by HTTP clients to adjust service requests.

Example usage

use rocket;
use rocket_governor;

#[rocket::launch]
fn launch_rocket() -> _ {
    rocket::build().attach(rocket_governor::LimitHeaderGen::default())
}

Trait Implementations

impl Default for LimitHeaderGen

fn default() -> Self

Returns the “default value” for a type.

impl Fairing for LimitHeaderGen

fn on_response<'r, 'life0, 'life1, 'life2, 'async_trait>(
    &'life0 self,
    request: &'r Request<'life1>,
    response: &'life2 mut Response<'r>
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>> where
    'r: 'async_trait,
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait, 

Set rate limit headers if RocketGovernable::limit_info_allow() returns true and ReqState has been cached in this case in Request::local_cache.

fn info(&self) -> Info

Returns an Info structure containing the name and Kind of this fairing. The name can be any arbitrary string. Kind must be an ord set of Kind variants.

fn on_ignite<'life0, 'async_trait>(
    &'life0 self,
    rocket: Rocket<Build>
) -> Pin<Box<dyn Future<Output = Result<Rocket<Build>, Rocket<Build>>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

The ignite callback. Returns Ok if ignition should proceed and Err if ignition and launch should be aborted.

fn on_liftoff<'life0, 'life1, 'async_trait>(
    &'life0 self,
    _rocket: &'life1 Rocket<Orbit>
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

The liftoff callback.

fn on_request<'life0, 'life1, 'life2, 'life3, 'life4, 'async_trait>(
    &'life0 self,
    _req: &'life1 mut Request<'life2>,
    _data: &'life3 mut Data<'life4>
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    'life3: 'async_trait,
    'life4: 'async_trait,
    Self: 'async_trait, 

The request callback.

fn on_shutdown<'life0, 'life1, 'async_trait>(
    &'life0 self,
    _rocket: &'life1 Rocket<Orbit>
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

The shutdown callback.