use {Rocket, Request, Response, Data}; use fairing::{Fairing, Kind, Info}; /// 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 the [`on_attach`](#method.on_attach), [`on_launch`](#method.on_launch), /// [`on_request`](#method.on_request), or [`on_response`](#method.on_response) /// constructors 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 launch fairing, simply prints a message indicating that the /// application is about to the launch. The second, a request fairing, rewrites /// the method of all requests to be `PUT`. /// /// ```rust /// use rocket::fairing::AdHoc; /// use rocket::http::Method; /// /// rocket::ignite() /// .attach(AdHoc::on_launch(|_| { /// println!("Rocket is about to launch! Exciting! Here we go..."); /// })) /// .attach(AdHoc::on_request(|req, _| { /// req.set_method(Method::Put); /// })); /// ``` pub enum AdHoc { /// An ad-hoc **attach** fairing. Called when the fairing is attached. #[doc(hidden)] Attach(Box Result + Send + Sync + 'static>), /// An ad-hoc **launch** fairing. Called just before Rocket launches. #[doc(hidden)] Launch(Box), /// An ad-hoc **request** fairing. Called when a request is received. #[doc(hidden)] Request(Box), /// An ad-hoc **response** fairing. Called when a response is ready to be /// sent to a client. #[doc(hidden)] Response(Box), } impl AdHoc { /// Constructs an `AdHoc` attach fairing. The function `f` will be called by /// Rocket when this fairing is attached. /// /// # Example /// /// ```rust /// use rocket::fairing::AdHoc; /// /// // The no-op attach fairing. /// let fairing = AdHoc::on_attach(|rocket| Ok(rocket)); /// ``` pub fn on_attach(f: F) -> AdHoc where F: Fn(Rocket) -> Result + Send + Sync + 'static { AdHoc::Attach(Box::new(f)) } /// Constructs an `AdHoc` launch fairing. The function `f` will be called by /// Rocket just prior to launching. /// /// # Example /// /// ```rust /// use rocket::fairing::AdHoc; /// /// // A fairing that prints a message just before launching. /// let fairing = AdHoc::on_launch(|rocket| { /// println!("Launching in T-3..2..1.."); /// }); /// ``` pub fn on_launch(f: F) -> AdHoc where F: Fn(&Rocket) + Send + Sync + 'static { AdHoc::Launch(Box::new(f)) } /// Constructs an `AdHoc` request fairing. The function `f` will be called /// by Rocket when a new request is received. /// /// # Example /// /// ```rust /// use rocket::fairing::AdHoc; /// /// // The no-op request fairing. /// let fairing = AdHoc::on_request(|req, data| { /// // do something with the request and data... /// # let (_, _) = (req, data); /// }); /// ``` pub fn on_request(f: F) -> AdHoc where F: Fn(&mut Request, &Data) + Send + Sync + 'static { AdHoc::Request(Box::new(f)) } /// Constructs an `AdHoc` response fairing. The function `f` will be called /// by Rocket when a response is ready to be sent. /// /// # Example /// /// ```rust /// use rocket::fairing::AdHoc; /// /// // The no-op response fairing. /// let fairing = AdHoc::on_response(|req, resp| { /// // do something with the request and pending response... /// # let (_, _) = (req, resp); /// }); /// ``` pub fn on_response(f: F) -> AdHoc where F: Fn(&Request, &mut Response) + Send + Sync + 'static { AdHoc::Response(Box::new(f)) } } impl Fairing for AdHoc { fn info(&self) -> Info { use self::AdHoc::*; match *self { Attach(_) => { Info { name: "AdHoc::Attach", kind: Kind::Attach, } } Launch(_) => { Info { name: "AdHoc::Launch", kind: Kind::Launch, } } Request(_) => { Info { name: "AdHoc::Request", kind: Kind::Request, } } Response(_) => { Info { name: "AdHoc::Response", kind: Kind::Response, } } } } fn on_attach(&self, rocket: Rocket) -> Result { match *self { AdHoc::Attach(ref callback) => callback(rocket), _ => Ok(rocket), } } fn on_launch(&self, rocket: &Rocket) { if let AdHoc::Launch(ref callback) = *self { callback(rocket) } } fn on_request(&self, request: &mut Request, data: &Data) { if let AdHoc::Request(ref callback) = *self { callback(request, data) } } fn on_response(&self, request: &Request, response: &mut Response) { if let AdHoc::Response(ref callback) = *self { callback(request, response) } } }