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 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286
use std::borrow::{Borrow, Cow}; use std::ops::Deref; use std::str::FromStr; use std::fmt; use ext::IntoCollection; use http::{Header, MediaType, Source}; use http::hyper::mime::Mime; /// Representation of HTTP Content-Types. /// /// # Usage /// /// `ContentTypes` should rarely be created directly. Instead, an associated /// constant should be used; one is declared for most commonly used content /// types. /// /// ## Example /// /// A Content-Type of `text/html; charset=utf-8` can be instantiated via the /// `HTML` constant: /// /// ```rust /// use rocket::http::ContentType; /// /// # #[allow(unused_variables)] /// let html = ContentType::HTML; /// ``` /// /// # Header /// /// `ContentType` implements `Into<Header>`. As such, it can be used in any /// context where an `Into<Header>` is expected: /// /// ```rust /// use rocket::http::ContentType; /// use rocket::response::Response; /// /// # #[allow(unused_variables)] /// let response = Response::build().header(ContentType::HTML).finalize(); /// ``` #[derive(Debug, Clone, PartialEq, Hash)] pub struct ContentType(pub MediaType); macro_rules! content_types { ($($name:ident ($check:ident): $str:expr, $t:expr, $s:expr $(; $k:expr => $v:expr)*),+) => { $( #[doc="Content-Type for <b>"] #[doc=$str] #[doc="</b>: <i>"] #[doc=$t] #[doc="/"] #[doc=$s] $(#[doc="; "] #[doc=$k] #[doc=" = "] #[doc=$v])* #[doc="</i>"] #[allow(non_upper_case_globals)] pub const $name: ContentType = ContentType(MediaType::$name); )+ }; } impl ContentType { /// Creates a new `ContentType` with top-level type `top` and subtype `sub`. /// This should _only_ be used to construct uncommon or custom content /// types. Use an associated constant for everything else. /// /// # Example /// /// Create a custom `application/x-person` content type: /// /// ```rust /// use rocket::http::ContentType; /// /// let custom = ContentType::new("application", "x-person"); /// assert_eq!(custom.top(), "application"); /// assert_eq!(custom.sub(), "x-person"); /// ``` #[inline(always)] pub fn new<T, S>(top: T, sub: S) -> ContentType where T: Into<Cow<'static, str>>, S: Into<Cow<'static, str>> { ContentType(MediaType::new(top, sub)) } /// Returns the Content-Type associated with the extension `ext` if the /// extension is recognized. Not all extensions are recognized. If an /// extensions is not recognized, then this method returns `None`. The /// currently recognized extensions are txt, html, htm, xml, csv, js, css, /// json, png, gif, bmp, jpeg, jpg, webp, svg, pdf, ttf, otf, woff, and /// woff2. Extensions are matched case-insensitively. /// /// # Example /// /// Recognized content types: /// /// ```rust /// use rocket::http::ContentType; /// /// let xml = ContentType::from_extension("xml"); /// assert_eq!(xml, Some(ContentType::XML)); /// /// let xml = ContentType::from_extension("XML"); /// assert_eq!(xml, Some(ContentType::XML)); /// ``` /// /// An unrecognized content type: /// /// ```rust /// use rocket::http::ContentType; /// /// let foo = ContentType::from_extension("foo"); /// assert!(foo.is_none()); /// ``` #[inline] pub fn from_extension(ext: &str) -> Option<ContentType> { MediaType::from_extension(ext).map(ContentType) } /// Creates a new `ContentType` with top-level type `top`, subtype `sub`, /// and parameters `ps`. This should _only_ be used to construct uncommon or /// custom content types. Use an associated constant for everything else. /// /// # Example /// /// Create a custom `application/x-id; id=1` content type: /// /// ```rust /// use rocket::http::ContentType; /// /// let id = ContentType::with_params("application", "x-id", ("id", "1")); /// assert_eq!(id.to_string(), "application/x-id; id=1".to_string()); /// ``` /// /// Create a custom `text/person; name=bob; weight=175` content type: /// /// ```rust /// use rocket::http::ContentType; /// /// let params = vec![("name", "bob"), ("ref", "2382")]; /// let mt = ContentType::with_params("text", "person", params); /// assert_eq!(mt.to_string(), "text/person; name=bob; ref=2382".to_string()); /// ``` #[inline] pub fn with_params<T, S, K, V, P>(top: T, sub: S, ps: P) -> ContentType where T: Into<Cow<'static, str>>, S: Into<Cow<'static, str>>, K: Into<Cow<'static, str>>, V: Into<Cow<'static, str>>, P: IntoCollection<(K, V)> { ContentType(MediaType::with_params(top, sub, ps)) } /// Borrows the inner `MediaType` of `self`. /// /// # Example /// /// ```rust /// use rocket::http::{ContentType, MediaType}; /// /// let http = ContentType::HTML; /// let media_type = http.media_type(); /// ``` #[inline(always)] pub fn media_type(&self) -> &MediaType { &self.0 } known_media_types!(content_types); } impl Default for ContentType { /// Returns a ContentType of `Any`, or `*/*`. #[inline(always)] fn default() -> ContentType { ContentType::Any } } impl Deref for ContentType { type Target = MediaType; #[inline(always)] fn deref(&self) -> &MediaType { &self.0 } } #[doc(hidden)] impl<T: Borrow<Mime>> From<T> for ContentType { #[inline(always)] default fn from(mime: T) -> ContentType { let mime: Mime = mime.borrow().clone(); ContentType::from(mime) } } #[doc(hidden)] impl From<Mime> for ContentType { #[inline] fn from(mime: Mime) -> ContentType { // soooo inneficient. let params = mime.2.into_iter() .map(|(attr, value)| (attr.to_string(), value.to_string())) .collect::<Vec<_>>(); ContentType::with_params(mime.0.to_string(), mime.1.to_string(), params) } } impl FromStr for ContentType { type Err = String; /// Parses a `ContentType` from a given Content-Type header value. /// /// # Examples /// /// Parsing an `application/json`: /// /// ```rust /// use std::str::FromStr; /// use rocket::http::ContentType; /// /// let json = ContentType::from_str("application/json").unwrap(); /// assert!(json.is_known()); /// assert_eq!(json, ContentType::JSON); /// ``` /// /// Parsing a content type extension: /// /// ```rust /// use std::str::FromStr; /// use rocket::http::ContentType; /// /// let custom = ContentType::from_str("application/x-custom").unwrap(); /// assert!(!custom.is_known()); /// assert_eq!(custom.top(), "application"); /// assert_eq!(custom.sub(), "x-custom"); /// ``` /// /// Parsing an invalid Content-Type value: /// /// ```rust /// use std::str::FromStr; /// use rocket::http::ContentType; /// /// let custom = ContentType::from_str("application//x-custom"); /// assert!(custom.is_err()); /// ``` #[inline(always)] fn from_str(raw: &str) -> Result<ContentType, String> { MediaType::from_str(raw).map(|mt| ContentType(mt)) } } impl fmt::Display for ContentType { /// Formats the ContentType as an HTTP Content-Type value. /// /// # Example /// /// ```rust /// use rocket::http::ContentType; /// /// let ct = format!("{}", ContentType::JSON); /// assert_eq!(ct, "application/json"); /// ``` #[inline(always)] fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { write!(f, "{}", self.0) } } /// Creates a new `Header` with name `Content-Type` and the value set to the /// HTTP rendering of this Content-Type. impl Into<Header<'static>> for ContentType { #[inline(always)] fn into(self) -> Header<'static> { // FIXME: For known media types, don't do `to_string`. Store the whole // string as a `source` and have a way to know that the source is // everything. That removes the allocation here. Then, in // `MediaType::fmt`, write the source string out directly as well. // // We could also use an `enum` for MediaType. But that kinda sucks. But // maybe it's what we want. if let Source::Known(src) = self.0.source { Header::new("Content-Type", src) } else { Header::new("Content-Type", self.to_string()) } } }