1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184
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<Fn(Rocket) -> Result<Rocket, Rocket> + Send + Sync + 'static>), /// An ad-hoc **launch** fairing. Called just before Rocket launches. #[doc(hidden)] Launch(Box<Fn(&Rocket) + Send + Sync + 'static>), /// An ad-hoc **request** fairing. Called when a request is received. #[doc(hidden)] Request(Box<Fn(&mut Request, &Data) + Send + Sync + 'static>), /// An ad-hoc **response** fairing. Called when a response is ready to be /// sent to a client. #[doc(hidden)] Response(Box<Fn(&Request, &mut Response) + Send + Sync + 'static>), } 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: F) -> AdHoc where F: Fn(Rocket) -> Result<Rocket, Rocket> + 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: 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: 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: 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<Rocket, Rocket> { 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) } } }