Struct rocket::fairing::AdHoc[][src]

pub struct AdHoc { /* fields omitted */ }
Expand description

A ad-hoc fairing that can be created from a function or closure.

This enum can be used to create a fairing from a simple function or closure without creating a new structure or implementing Fairing directly.

Usage

Use AdHoc::on_ignite, AdHoc::on_liftoff, AdHoc::on_request(), or AdHoc::on_response() to create an AdHoc structure from a function or closure. Then, simply attach the structure to the Rocket instance.

Example

The following snippet creates a Rocket instance with two ad-hoc fairings. The first, a liftoff fairing named “Liftoff Printer”, simply prints a message indicating that Rocket has launched. The second named “Put Rewriter”, a request fairing, rewrites the method of all requests to be PUT.

use rocket::fairing::AdHoc;
use rocket::http::Method;

rocket::build()
    .attach(AdHoc::on_liftoff("Liftoff Printer", |_| Box::pin(async move {
        println!("...annnddd we have liftoff!");
    })))
    .attach(AdHoc::on_request("Put Rewriter", |req, _| Box::pin(async move {
        req.set_method(Method::Put);
    })));

Implementations

impl AdHoc[src]

pub fn on_ignite<F, Fut>(name: &'static str, f: F) -> AdHoc where
    F: FnOnce(Rocket<Build>) -> Fut + Send + 'static,
    Fut: Future<Output = Rocket<Build>> + Send + 'static, 
[src]

Constructs an AdHoc ignite fairing named name. The function f will be called by Rocket during the Rocket::ignite() phase.

This version of an AdHoc ignite fairing cannot abort ignite. For a fallible version that can, see AdHoc::try_on_ignite().

Example

use rocket::fairing::AdHoc;

// The no-op ignite fairing.
let fairing = AdHoc::on_ignite("Boom!", |rocket| async move {
    rocket
});

pub fn try_on_ignite<F, Fut>(name: &'static str, f: F) -> AdHoc where
    F: FnOnce(Rocket<Build>) -> Fut + Send + 'static,
    Fut: Future<Output = Result> + Send + 'static, 
[src]

Constructs an AdHoc ignite fairing named name. The function f will be called by Rocket during the Rocket::ignite() phase. Returning an Err aborts ignition and thus launch.

For an infallible version, see AdHoc::on_ignite().

Example

use rocket::fairing::AdHoc;

// The no-op try ignite fairing.
let fairing = AdHoc::try_on_ignite("No-Op", |rocket| async { Ok(rocket) });

pub fn on_liftoff<F: Send + Sync + 'static>(name: &'static str, f: F) -> AdHoc where
    F: for<'a> FnOnce(&'a Rocket<Orbit>) -> BoxFuture<'a, ()>, 
[src]

Constructs an AdHoc liftoff fairing named name. The function f will be called by Rocket just after Rocket::launch().

Example

use rocket::fairing::AdHoc;

// A fairing that prints a message just before launching.
let fairing = AdHoc::on_liftoff("Boom!", |_| Box::pin(async move {
    println!("Rocket has lifted off!");
}));

pub fn on_request<F: Send + Sync + 'static>(name: &'static str, f: F) -> AdHoc where
    F: for<'a> Fn(&'a mut Request<'_>, &'a Data<'_>) -> BoxFuture<'a, ()>, 
[src]

Constructs an AdHoc request fairing named name. The function f will be called and the returned Future will be awaited by Rocket when a new request is received.

Example

use rocket::fairing::AdHoc;

// The no-op request fairing.
let fairing = AdHoc::on_request("Dummy", |req, data| {
    Box::pin(async move {
        // do something with the request and data...
    })
});

pub fn on_response<F: Send + Sync + 'static>(name: &'static str, f: F) -> AdHoc where
    F: for<'b, 'r> Fn(&'r Request<'_>, &'b mut Response<'r>) -> BoxFuture<'b, ()>, 
[src]

Constructs an AdHoc response fairing named name. The function f will be called and the returned Future will be awaited by Rocket when a response is ready to be sent.

Example

use rocket::fairing::AdHoc;

// The no-op response fairing.
let fairing = AdHoc::on_response("Dummy", |req, resp| {
    Box::pin(async move {
        // do something with the request and pending response...
    })
});

pub fn config<'de, T>() -> AdHoc where
    T: Deserialize<'de> + Send + Sync + 'static, 
[src]

Constructs an AdHoc launch fairing that extracts a configuration of type T from the configured provider and stores it in managed state. If extractions fails, pretty-prints the error message and aborts launch.

Example

use serde::Deserialize;
use rocket::fairing::AdHoc;

#[derive(Deserialize)]
struct Config {
    field: String,
    other: usize,
    /* and so on.. */
}

#[launch]
fn rocket() -> _ {
    rocket::build().attach(AdHoc::config::<Config>())
}

Trait Implementations

impl Fairing for AdHoc[src]

fn info(&self) -> Info[src]

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. Read more

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

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

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

The liftoff callback. Read more

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>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    'life3: 'async_trait,
    'life4: 'async_trait,
    Self: 'async_trait, 
[src]

The request callback. Read more

fn on_response<'r, 'life0, 'life1, 'life2, 'async_trait>(
    &'life0 self,
    req: &'r Request<'life1>,
    res: &'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, 
[src]

The response callback. Read more

Auto Trait Implementations

impl !RefUnwindSafe for AdHoc

impl Send for AdHoc

impl Sync for AdHoc

impl Unpin for AdHoc

impl !UnwindSafe for AdHoc

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T> Instrument for T[src]

fn instrument(self, span: Span) -> Instrumented<Self>[src]

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

fn in_current_span(self) -> Instrumented<Self>[src]

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

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> IntoCollection<T> for T

pub fn into_collection<A>(self) -> SmallVec<A> where
    A: Array<Item = T>, 

Converts self into a collection.

pub fn mapped<U, F, A>(self, f: F) -> SmallVec<A> where
    F: FnMut(T) -> U,
    A: Array<Item = U>, 

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.

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

Performs the conversion.

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

pub fn vzip(self) -> V