Struct rocket_session::SessionFairing

pub struct SessionFairing<D>where
    D: 'static + Sync + Send + Default,{ /* private fields */ }

Fairing struct

Implementations

impl<D> SessionFairing<D>where
    D: 'static + Sync + Send + Default,

pub fn with_lifetime(self, time: Duration) -> Self

Set session lifetime (expiration time).

Call on the fairing before passing it to rocket.attach()

Examples found in repository

examples/minimal/main.rs (line 12)

fn rocket() -> _ {
    // This session expires in 15 seconds as a demonstration of session configuration
    rocket::build()
        .attach(Session::fairing().with_lifetime(Duration::from_secs(15)))
        .mount("/", routes![index])
}

examples/visit_counter/main.rs (line 27)

fn rocket() -> _ {
    rocket::build()
        .attach(
            Session::fairing()
                // 10 seconds of inactivity until session expires
                // (wait 10s and refresh, the numbers will reset)
                .with_lifetime(Duration::from_secs(10))
                // custom cookie name and length
                .with_cookie_name("my_cookie")
                .with_cookie_len(20),
        )
        .mount("/", routes![index, about])
}

pub fn with_cookie_name(self, name: impl Into<Cow<'static, str>>) -> Self

Set session cookie name and length

Call on the fairing before passing it to rocket.attach()

Examples found in repository

examples/visit_counter/main.rs (line 29)

fn rocket() -> _ {
    rocket::build()
        .attach(
            Session::fairing()
                // 10 seconds of inactivity until session expires
                // (wait 10s and refresh, the numbers will reset)
                .with_lifetime(Duration::from_secs(10))
                // custom cookie name and length
                .with_cookie_name("my_cookie")
                .with_cookie_len(20),
        )
        .mount("/", routes![index, about])
}

pub fn with_cookie_len(self, length: usize) -> Self

Set session cookie name and length

Call on the fairing before passing it to rocket.attach()

Examples found in repository

examples/visit_counter/main.rs (line 30)

fn rocket() -> _ {
    rocket::build()
        .attach(
            Session::fairing()
                // 10 seconds of inactivity until session expires
                // (wait 10s and refresh, the numbers will reset)
                .with_lifetime(Duration::from_secs(10))
                // custom cookie name and length
                .with_cookie_name("my_cookie")
                .with_cookie_len(20),
        )
        .mount("/", routes![index, about])
}

pub fn with_cookie_path(self, path: impl Into<Cow<'static, str>>) -> Self

Set session cookie name and length

Call on the fairing before passing it to rocket.attach()

Trait Implementations

impl<D> Default for SessionFairing<D>where
    D: 'static + Sync + Send + Default + Default,

fn default() -> SessionFairing<D>

Returns the “default value” for a type.

impl<D> Fairing for SessionFairing<D>where
    D: 'static + Sync + Send + Default,

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>>where
    Self: 'async_trait,
    'life0: 'async_trait,

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

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

The response callback.

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.