mime-0.3.9/.gitignore010066400017500001750000000000241244344310200126560ustar0000000000000000/target /Cargo.lock mime-0.3.9/.travis.yml010066400017500001750000000005321333334621600130120ustar0000000000000000language: rust matrix: fast_finish: true allow_failures: - rust: nightly include: - rust: stable - rust: beta - rust: nightly - rust: 1.15.0 sudo: false dist: trusty cache: cargo script: - cargo build - cargo clean - cargo test - rustdoc --test README.md -L target/debug/deps mime-0.3.9/CONTRIBUTING.md010066400017500001750000000007621331576740400131450ustar0000000000000000# Contributing to mime ## License Licensed under either of - Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://apache.org/licenses/LICENSE-2.0) - MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) ### Contribution Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions. mime-0.3.9/Cargo.toml.orig010066400017500001750000000005571333335434400136000ustar0000000000000000[package] name = "mime" version = "0.3.9" # remember to update html_root_url authors = ["Sean McArthur "] license = "MIT/Apache-2.0" description = "Strongly Typed Mimes" documentation = "https://docs.rs/mime" repository = "https://github.com/hyperium/mime" keywords = ["mime", "media-extensions", "media-types"] [dependencies] unicase = "2.0" mime-0.3.9/Cargo.toml0000644000000015360000000000000100360ustar00# THIS FILE IS AUTOMATICALLY GENERATED BY CARGO # # When uploading crates to the registry Cargo will automatically # "normalize" Cargo.toml files for maximal compatibility # with all versions of Cargo and also rewrite `path` dependencies # to registry (e.g. crates.io) dependencies # # If you believe there's an error in this file please file an # issue against the rust-lang/cargo repository. If you're # editing this file be aware that the upstream Cargo.toml # will likely look very different (and much more reasonable) [package] name = "mime" version = "0.3.9" authors = ["Sean McArthur "] description = "Strongly Typed Mimes" documentation = "https://docs.rs/mime" keywords = ["mime", "media-extensions", "media-types"] license = "MIT/Apache-2.0" repository = "https://github.com/hyperium/mime" [dependencies.unicase] version = "2.0" mime-0.3.9/LICENSE-APACHE010066400017500001750000000251371311631530700126310ustar0000000000000000 Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. mime-0.3.9/LICENSE-MIT010066400017500001750000000020421311631530700123270ustar0000000000000000Copyright (c) 2014 Sean McArthur Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. mime-0.3.9/README.md010066400017500001750000000013061333334621600121600ustar0000000000000000# mime [![Build Status](https://travis-ci.org/hyperium/mime.svg?branch=master)](https://travis-ci.org/hyperium/mime) [![crates.io](https://img.shields.io/crates/v/mime.svg)](https://crates.io/crates/mime) [![docs.rs](https://docs.rs/mime/badge.svg)](https://docs.rs/mime) Support MIME (Media Types) as strong types in Rust. [Documentation](https://docs.rs/mime) ## Usage ```rust extern crate mime; // common types are constants let text = mime::TEXT_PLAIN; // deconstruct Mimes to match on them match (text.type_(), text.subtype()) { (mime::TEXT, mime::PLAIN) => { // plain text! }, (mime::TEXT, _) => { // structured text! }, _ => { // not text! } } ``` mime-0.3.9/benches/cmp.rs010066400017500001750000000016221311631530700134320ustar0000000000000000#![feature(test)] extern crate mime; extern crate test; use mime::*; use test::Bencher; #[bench] fn bench_eq_parsed(b: &mut Bencher) { let mime = "text/plain; charset=utf-8".parse::().unwrap(); b.bytes = mime.as_ref().len() as u64; b.iter(|| { assert_eq!(mime, TEXT_PLAIN_UTF_8); }) } #[bench] fn bench_eq_consts(b: &mut Bencher) { let mime = TEXT_PLAIN_UTF_8; b.bytes = mime.as_ref().len() as u64; b.iter(|| { assert_eq!(mime, TEXT_PLAIN_UTF_8); }); } #[bench] fn bench_ne_consts(b: &mut Bencher) { let one = TEXT_XML; let two = TEXT_CSS; b.bytes = one.as_ref().len() as u64; b.iter(|| { assert_ne!(one, two); }); } #[bench] fn bench_eq_type_(b: &mut Bencher) { let mime = TEXT_PLAIN_UTF_8; let name = TEXT; b.bytes = name.as_ref().len() as u64; b.iter(|| { assert_eq!(mime.type_(), name); }); } mime-0.3.9/benches/fmt.rs010066400017500001750000000006511311631530700134420ustar0000000000000000#![feature(test)] extern crate mime; extern crate test; use test::Bencher; #[bench] fn bench_fmt(b: &mut Bencher) { use std::fmt::Write; let mime = ::mime::TEXT_PLAIN_UTF_8; b.bytes = mime.to_string().as_bytes().len() as u64; let mut s = String::with_capacity(64); b.iter(|| { let _ = write!(s, "{}", mime); ::test::black_box(&s); unsafe { s.as_mut_vec().set_len(0); } }) } mime-0.3.9/benches/parse.rs010066400017500001750000000011321311631530700137610ustar0000000000000000#![feature(test)] extern crate mime; extern crate test; use mime::Mime; use test::Bencher; #[bench] fn bench_from_str(b: &mut Bencher) { let s = "text/plain"; b.bytes = s.as_bytes().len() as u64; b.iter(|| s.parse::()) } #[bench] fn bench_from_str_charset_utf8(b: &mut Bencher) { let s = "text/plain; charset=utf-8"; b.bytes = s.as_bytes().len() as u64; b.iter(|| s.parse::()) } #[bench] fn bench_from_str_extended(b: &mut Bencher) { let s = "text/plain; charset=utf-8; foo=bar"; b.bytes = s.as_bytes().len() as u64; b.iter(|| s.parse::()) } mime-0.3.9/src/lib.rs010066400017500001750000000570601333335435500126170ustar0000000000000000//! # Mime //! //! Mime is now Media Type, technically, but `Mime` is more immediately //! understandable, so the main type here is `Mime`. //! //! ## What is Mime? //! //! Example mime string: `text/plain` //! //! ``` //! let plain_text: mime::Mime = "text/plain".parse().unwrap(); //! assert_eq!(plain_text, mime::TEXT_PLAIN); //! ``` //! //! ## Inspecting Mimes //! //! ``` //! let mime = mime::TEXT_PLAIN; //! match (mime.type_(), mime.subtype()) { //! (mime::TEXT, mime::PLAIN) => println!("plain text!"), //! (mime::TEXT, _) => println!("structured text"), //! _ => println!("not text"), //! } //! ``` #![doc(html_root_url = "https://docs.rs/mime/0.3.9")] #![deny(warnings)] #![deny(missing_docs)] #![deny(missing_debug_implementations)] extern crate unicase; use std::cmp::Ordering; use std::error::Error; use std::fmt; use std::hash::{Hash, Hasher}; use std::str::FromStr; use std::slice; mod parse; /// A parsed mime or media type. #[derive(Clone)] pub struct Mime { source: Source, slash: usize, plus: Option, params: ParamSource, } /// A section of a `Mime`. /// /// For instance, for the Mime `image/svg+xml`, it contains 3 `Name`s, /// `image`, `svg`, and `xml`. /// /// In most cases, `Name`s are compared ignoring case. #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)] pub struct Name<'a> { // TODO: optimize with an Atom-like thing // There a `const` Names, and so it is possible for the statis strings // to havea different memory address. Additionally, when used in match // statements, the strings are compared with a memcmp, possibly even // if the address and length are the same. // // Being an enum with an Atom variant that is a usize (and without a // string pointer and boolean) would allow for faster comparisons. source: &'a str, insensitive: bool, } /// An error when parsing a `Mime` from a string. #[derive(Debug)] pub struct FromStrError { inner: parse::ParseError, } impl Error for FromStrError { fn description(&self) -> &str { "an error occurred while parsing a MIME type" } } impl fmt::Display for FromStrError { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { write!(f, "{}: {}", self.description(), self.inner) } } #[derive(Clone)] enum Source { Atom(u8, &'static str), Dynamic(String), } impl Source { fn as_ref(&self) -> &str { match *self { Source::Atom(_, s) => s, Source::Dynamic(ref s) => s, } } } #[derive(Clone)] enum ParamSource { Utf8(usize), Custom(usize, Vec<(Indexed, Indexed)>), None, } #[derive(Clone, Copy)] struct Indexed(usize, usize); impl Mime { /// Get the top level media type for this `Mime`. /// /// # Example /// /// ``` /// let mime = mime::TEXT_PLAIN; /// assert_eq!(mime.type_(), "text"); /// assert_eq!(mime.type_(), mime::TEXT); /// ``` #[inline] pub fn type_(&self) -> Name { Name { source: &self.source.as_ref()[..self.slash], insensitive: true, } } /// Get the subtype of this `Mime`. /// /// # Example /// /// ``` /// let mime = mime::TEXT_PLAIN; /// assert_eq!(mime.subtype(), "plain"); /// assert_eq!(mime.subtype(), mime::PLAIN); /// ``` #[inline] pub fn subtype(&self) -> Name { let end = self.plus.unwrap_or_else(|| { return self.semicolon().unwrap_or(self.source.as_ref().len()) }); Name { source: &self.source.as_ref()[self.slash + 1..end], insensitive: true, } } /// Get an optional +suffix for this `Mime`. /// /// # Example /// /// ``` /// let svg = "image/svg+xml".parse::().unwrap(); /// assert_eq!(svg.suffix(), Some(mime::XML)); /// assert_eq!(svg.suffix().unwrap(), "xml"); /// /// /// assert!(mime::TEXT_PLAIN.suffix().is_none()); /// ``` #[inline] pub fn suffix(&self) -> Option { let end = self.semicolon().unwrap_or(self.source.as_ref().len()); self.plus.map(|idx| Name { source: &self.source.as_ref()[idx + 1..end], insensitive: true, }) } /// Look up a parameter by name. /// /// # Example /// /// ``` /// let mime = mime::TEXT_PLAIN_UTF_8; /// assert_eq!(mime.get_param(mime::CHARSET), Some(mime::UTF_8)); /// assert_eq!(mime.get_param("charset").unwrap(), "utf-8"); /// assert!(mime.get_param("boundary").is_none()); /// /// let mime = "multipart/form-data; boundary=ABCDEFG".parse::().unwrap(); /// assert_eq!(mime.get_param(mime::BOUNDARY).unwrap(), "ABCDEFG"); /// ``` pub fn get_param<'a, N>(&'a self, attr: N) -> Option> where N: PartialEq> { self.params().find(|e| attr == e.0).map(|e| e.1) } /// Returns an iterator over the parameters. #[inline] pub fn params<'a>(&'a self) -> Params<'a> { let inner = match self.params { ParamSource::Utf8(_) => ParamsInner::Utf8, ParamSource::Custom(_, ref params) => { ParamsInner::Custom { source: &self.source, params: params.iter(), } } ParamSource::None => ParamsInner::None, }; Params(inner) } #[inline] fn semicolon(&self) -> Option { match self.params { ParamSource::Utf8(i) | ParamSource::Custom(i, _) => Some(i), ParamSource::None => None, } } fn atom(&self) -> u8 { match self.source { Source::Atom(a, _) => a, _ => 0, } } } // Mime ============ fn mime_eq_str(mime: &Mime, s: &str) -> bool { if let ParamSource::Utf8(semicolon) = mime.params { if mime.source.as_ref().len() == s.len() { unicase::eq_ascii(mime.source.as_ref(), s) } else { params_eq(semicolon, mime.source.as_ref(), s) } } else if let Some(semicolon) = mime.semicolon() { params_eq(semicolon, mime.source.as_ref(), s) } else { unicase::eq_ascii(mime.source.as_ref(), s) } } fn params_eq(semicolon: usize, a: &str, b: &str) -> bool { if b.len() < semicolon + 1 { false } else if !unicase::eq_ascii(&a[..semicolon], &b[..semicolon]) { false } else { // gotta check for quotes, LWS, and for case senstive names let mut a = &a[semicolon + 1..]; let mut b = &b[semicolon + 1..]; let mut sensitive; loop { a = a.trim(); b = b.trim(); match (a.is_empty(), b.is_empty()) { (true, true) => return true, (true, false) | (false, true) => return false, (false, false) => (), } //name if let Some(a_idx) = a.find('=') { let a_name = a[..a_idx].trim_left(); if let Some(b_idx) = b.find('=') { let b_name = b[..b_idx].trim_left(); if !unicase::eq_ascii(a_name, b_name) { return false; } sensitive = a_name != CHARSET; a = &a[..a_idx]; b = &b[..b_idx]; } else { return false; } } else { return false; } //value let a_quoted = if a.as_bytes()[0] == b'"' { a = &a[1..]; true } else { false }; let b_quoted = if b.as_bytes()[0] == b'"' { b = &b[1..]; true } else { false }; let a_end = if a_quoted { if let Some(quote) = a.find('"') { quote } else { return false; } } else { a.find(';').unwrap_or(a.len()) }; let b_end = if b_quoted { if let Some(quote) = b.find('"') { quote } else { return false; } } else { b.find(';').unwrap_or(b.len()) }; if sensitive { if !unicase::eq_ascii(&a[..a_end], &b[..b_end]) { return false; } } else { if &a[..a_end] != &b[..b_end] { return false; } } a = &a[a_end..]; b = &b[b_end..]; } } } impl PartialEq for Mime { #[inline] fn eq(&self, other: &Mime) -> bool { match (self.atom(), other.atom()) { // TODO: // This could optimize for when there are no customs parameters. // Any parsed mime has already been lowercased, so if there aren't // any parameters that are case sensistive, this can skip the // unicase::eq_ascii, and just use a memcmp instead. (0, _) | (_, 0) => mime_eq_str(self, other.source.as_ref()), (a, b) => a == b, } } } impl Eq for Mime {} impl PartialOrd for Mime { fn partial_cmp(&self, other: &Mime) -> Option { Some(self.cmp(other)) } } impl Ord for Mime { fn cmp(&self, other: &Mime) -> Ordering { self.source.as_ref().cmp(other.source.as_ref()) } } impl Hash for Mime { fn hash(&self, hasher: &mut T) { hasher.write(self.source.as_ref().as_bytes()); } } impl<'a> PartialEq<&'a str> for Mime { #[inline] fn eq(&self, s: & &'a str) -> bool { mime_eq_str(self, *s) } } impl<'a> PartialEq for &'a str { #[inline] fn eq(&self, mime: &Mime) -> bool { mime_eq_str(mime, *self) } } impl FromStr for Mime { type Err = FromStrError; fn from_str(s: &str) -> Result { parse::parse(s).map_err(|e| FromStrError { inner: e }) } } impl AsRef for Mime { #[inline] fn as_ref(&self) -> &str { self.source.as_ref() } } impl fmt::Debug for Mime { #[inline] fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { fmt::Debug::fmt(self.source.as_ref(), f) } } impl fmt::Display for Mime { #[inline] fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { fmt::Display::fmt(self.source.as_ref(), f) } } // Name ============ fn name_eq_str(name: &Name, s: &str) -> bool { if name.insensitive { unicase::eq_ascii(name.source, s) } else { name.source == s } } impl<'a> Name<'a> { /// Get the value of this `Name` as a string. /// /// Note that the borrow is not tied to `&self` but the `'a` lifetime, allowing the /// string to outlive `Name`. Alternately, there is an `impl<'a> From> for &'a str` /// which isn't rendered by Rustdoc, that can be accessed using `str::from(name)` or `name.into()`. pub fn as_str(&self) -> &'a str { self.source } } impl<'a, 'b> PartialEq<&'b str> for Name<'a> { #[inline] fn eq(&self, other: & &'b str) -> bool { name_eq_str(self, *other) } } impl<'a, 'b> PartialEq> for &'b str { #[inline] fn eq(&self, other: &Name<'a>) -> bool { name_eq_str(other, *self) } } impl<'a> AsRef for Name<'a> { #[inline] fn as_ref(&self) -> &str { self.source } } impl<'a> From> for &'a str { #[inline] fn from(name: Name<'a>) -> &'a str { name.source } } impl<'a> fmt::Debug for Name<'a> { #[inline] fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { fmt::Debug::fmt(self.source, f) } } impl<'a> fmt::Display for Name<'a> { #[inline] fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { fmt::Display::fmt(self.source, f) } } // Params =================== enum ParamsInner<'a> { Utf8, Custom { source: &'a Source, params: slice::Iter<'a, (Indexed, Indexed)>, }, None, } /// An iterator over the parameters of a MIME. pub struct Params<'a>(ParamsInner<'a>); impl<'a> fmt::Debug for Params<'a> { fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result { fmt.debug_struct("Params").finish() } } impl<'a> Iterator for Params<'a> { type Item = (Name<'a>, Name<'a>); #[inline] fn next(&mut self) -> Option<(Name<'a>, Name<'a>)> { match self.0 { ParamsInner::Utf8 => { let value = (CHARSET, UTF_8); self.0 = ParamsInner::None; Some(value) } ParamsInner::Custom { source, ref mut params } => { params.next().map(|&(name, value)| { let name = Name { source: &source.as_ref()[name.0..name.1], insensitive: true, }; let value = Name { source: &source.as_ref()[value.0..value.1], insensitive: name == CHARSET, }; (name, value) }) } ParamsInner::None => None } } #[inline] fn size_hint(&self) -> (usize, Option) { match self.0 { ParamsInner::Utf8 => (1, Some(1)), ParamsInner::Custom { ref params, .. } => params.size_hint(), ParamsInner::None => (0, Some(0)), } } } macro_rules! names { ($($id:ident, $e:expr;)*) => ( $( #[doc = $e] pub const $id: Name<'static> = Name { source: $e, insensitive: true, }; )* #[test] fn test_names_macro_consts() { #[allow(unused, deprecated)] use std::ascii::AsciiExt; $( assert_eq!($id.source.to_ascii_lowercase(), $id.source); )* } ) } names! { STAR, "*"; TEXT, "text"; IMAGE, "image"; AUDIO, "audio"; VIDEO, "video"; APPLICATION, "application"; MULTIPART, "multipart"; MESSAGE, "message"; MODEL, "model"; FONT, "font"; // common text/ * PLAIN, "plain"; HTML, "html"; XML, "xml"; JAVASCRIPT, "javascript"; CSS, "css"; CSV, "csv"; EVENT_STREAM, "event-stream"; VCARD, "vcard"; // common application/* JSON, "json"; WWW_FORM_URLENCODED, "x-www-form-urlencoded"; MSGPACK, "msgpack"; OCTET_STREAM, "octet-stream"; PDF, "pdf"; // common font/* WOFF, "woff"; WOFF2, "woff2"; // multipart/* FORM_DATA, "form-data"; // common image/* BMP, "bmp"; GIF, "gif"; JPEG, "jpeg"; PNG, "png"; SVG, "svg"; // audio/* BASIC, "basic"; MPEG, "mpeg"; MP4, "mp4"; OGG, "ogg"; // parameters CHARSET, "charset"; BOUNDARY, "boundary"; UTF_8, "utf-8"; } macro_rules! mimes { ($($id:ident, $($piece:expr),*;)*) => ( #[allow(non_camel_case_types)] enum __Atoms { __Dynamic, $( $id, )* } $( mime_constant! { $id, $($piece),* } )* #[test] fn test_mimes_macro_consts() { let _ = [ $( mime_constant_test! { $id, $($piece),* } ),* ].iter().enumerate().map(|(pos, &atom)| { assert_eq!(pos + 1, atom as usize, "atom {} in position {}", atom, pos + 1); }).collect::>(); } ) } macro_rules! mime_constant { ($id:ident, $src:expr, $slash:expr) => ( mime_constant!($id, $src, $slash, None); ); ($id:ident, $src:expr, $slash:expr, $plus:expr) => ( mime_constant!(FULL $id, $src, $slash, $plus, ParamSource::None); ); ($id:ident, $src:expr, $slash:expr, $plus:expr, $params:expr) => ( mime_constant!(FULL $id, $src, $slash, $plus, ParamSource::Utf8($params)); ); (FULL $id:ident, $src:expr, $slash:expr, $plus:expr, $params:expr) => ( #[doc = "`"] #[doc = $src] #[doc = "`"] pub const $id: Mime = Mime { source: Source::Atom(__Atoms::$id as u8, $src), slash: $slash, plus: $plus, params: $params, }; ) } #[cfg(test)] macro_rules! mime_constant_test { ($id:ident, $src:expr, $slash:expr) => ( mime_constant_test!($id, $src, $slash, None); ); ($id:ident, $src:expr, $slash:expr, $plus:expr) => ( mime_constant_test!(FULL $id, $src, $slash, $plus, ParamSource::None); ); ($id:ident, $src:expr, $slash:expr, $plus:expr, $params:expr) => ( mime_constant_test!(FULL $id, $src, $slash, $plus, ParamSource::Utf8($params)); ); (FULL $id:ident, $src:expr, $slash:expr, $plus:expr, $params:expr) => ({ let __mime = $id; let __slash = __mime.as_ref().as_bytes()[$slash]; assert_eq!(__slash, b'/', "{:?} has {:?} at slash position {:?}", __mime, __slash as char, $slash); if let Some(plus) = __mime.plus { let __c = __mime.as_ref().as_bytes()[plus]; assert_eq!(__c, b'+', "{:?} has {:?} at plus position {:?}", __mime, __c as char, plus); } else { assert!(!__mime.as_ref().as_bytes().contains(&b'+'), "{:?} forgot plus", __mime); } if let ParamSource::Utf8(semicolon) = __mime.params { assert_eq!(__mime.as_ref().as_bytes()[semicolon], b';'); assert_eq!(&__mime.as_ref()[semicolon..], "; charset=utf-8"); } else if let ParamSource::None = __mime.params { assert!(!__mime.as_ref().as_bytes().contains(&b';')); } else { unreachable!(); } __mime.atom() }) } mimes! { STAR_STAR, "*/*", 1; TEXT_STAR, "text/*", 4; TEXT_PLAIN, "text/plain", 4; TEXT_PLAIN_UTF_8, "text/plain; charset=utf-8", 4, None, 10; TEXT_HTML, "text/html", 4; TEXT_HTML_UTF_8, "text/html; charset=utf-8", 4, None, 9; TEXT_CSS, "text/css", 4; TEXT_CSS_UTF_8, "text/css; charset=utf-8", 4, None, 8; TEXT_JAVASCRIPT, "text/javascript", 4; TEXT_XML, "text/xml", 4; TEXT_EVENT_STREAM, "text/event-stream", 4; TEXT_CSV, "text/csv", 4; TEXT_CSV_UTF_8, "text/csv; charset=utf-8", 4, None, 8; TEXT_TAB_SEPARATED_VALUES, "text/tab-separated-values", 4; TEXT_TAB_SEPARATED_VALUES_UTF_8, "text/tab-separated-values; charset=utf-8", 4, None, 25; TEXT_VCARD, "text/vcard", 4; IMAGE_STAR, "image/*", 5; IMAGE_JPEG, "image/jpeg", 5; IMAGE_GIF, "image/gif", 5; IMAGE_PNG, "image/png", 5; IMAGE_BMP, "image/bmp", 5; IMAGE_SVG, "image/svg+xml", 5, Some(9); FONT_WOFF, "font/woff", 4; FONT_WOFF2, "font/woff2", 4; APPLICATION_JSON, "application/json", 11; APPLICATION_JAVASCRIPT, "application/javascript", 11; APPLICATION_JAVASCRIPT_UTF_8, "application/javascript; charset=utf-8", 11, None, 22; APPLICATION_WWW_FORM_URLENCODED, "application/x-www-form-urlencoded", 11; APPLICATION_OCTET_STREAM, "application/octet-stream", 11; APPLICATION_MSGPACK, "application/msgpack", 11; APPLICATION_PDF, "application/pdf", 11; MULTIPART_FORM_DATA, "multipart/form-data", 9; } #[deprecated(since="0.3.1", note="please use `TEXT_JAVASCRIPT` instead")] #[doc(hidden)] pub const TEXT_JAVSCRIPT: Mime = TEXT_JAVASCRIPT; #[cfg(test)] mod tests { use std::str::FromStr; use super::*; #[test] fn test_type_() { assert_eq!(TEXT_PLAIN.type_(), TEXT); } #[test] fn test_subtype() { assert_eq!(TEXT_PLAIN.subtype(), PLAIN); assert_eq!(TEXT_PLAIN_UTF_8.subtype(), PLAIN); let mime = Mime::from_str("text/html+xml").unwrap(); assert_eq!(mime.subtype(), HTML); } #[test] fn test_matching() { match (TEXT_PLAIN.type_(), TEXT_PLAIN.subtype()) { (TEXT, PLAIN) => (), _ => unreachable!(), } } #[test] fn test_suffix() { assert_eq!(TEXT_PLAIN.suffix(), None); let mime = Mime::from_str("text/html+xml").unwrap(); assert_eq!(mime.suffix(), Some(XML)); } #[test] fn test_mime_fmt() { let mime = TEXT_PLAIN; assert_eq!(mime.to_string(), "text/plain"); let mime = TEXT_PLAIN_UTF_8; assert_eq!(mime.to_string(), "text/plain; charset=utf-8"); } #[test] fn test_mime_from_str() { assert_eq!(Mime::from_str("text/plain").unwrap(), TEXT_PLAIN); assert_eq!(Mime::from_str("TEXT/PLAIN").unwrap(), TEXT_PLAIN); assert_eq!(Mime::from_str("text/plain; charset=utf-8").unwrap(), TEXT_PLAIN_UTF_8); assert_eq!(Mime::from_str("text/plain;charset=\"utf-8\"").unwrap(), TEXT_PLAIN_UTF_8); // quotes + semi colon Mime::from_str("text/plain;charset=\"utf-8\"; foo=bar").unwrap(); Mime::from_str("text/plain;charset=\"utf-8\" ; foo=bar").unwrap(); let upper = Mime::from_str("TEXT/PLAIN").unwrap(); assert_eq!(upper, TEXT_PLAIN); assert_eq!(upper.type_(), TEXT); assert_eq!(upper.subtype(), PLAIN); let extended = Mime::from_str("TEXT/PLAIN; CHARSET=UTF-8; FOO=BAR").unwrap(); assert_eq!(extended, "text/plain; charset=utf-8; foo=BAR"); assert_eq!(extended.get_param("charset").unwrap(), "utf-8"); assert_eq!(extended.get_param("foo").unwrap(), "BAR"); Mime::from_str("multipart/form-data; boundary=--------foobar").unwrap(); // stars assert_eq!("*/*".parse::().unwrap(), STAR_STAR); assert_eq!("image/*".parse::().unwrap(), "image/*"); assert_eq!("text/*; charset=utf-8".parse::().unwrap(), "text/*; charset=utf-8"); // parse errors Mime::from_str("f o o / bar").unwrap_err(); Mime::from_str("text\n/plain").unwrap_err(); Mime::from_str("text\r/plain").unwrap_err(); Mime::from_str("text/\r\nplain").unwrap_err(); Mime::from_str("text/plain;\r\ncharset=utf-8").unwrap_err(); Mime::from_str("text/plain; charset=\r\nutf-8").unwrap_err(); Mime::from_str("text/plain; charset=\"\r\nutf-8\"").unwrap_err(); } #[test] fn test_case_sensitive_values() { let mime = Mime::from_str("multipart/form-data; charset=BASE64; boundary=ABCDEFG").unwrap(); assert_eq!(mime.get_param(CHARSET).unwrap(), "bAsE64"); assert_eq!(mime.get_param(BOUNDARY).unwrap(), "ABCDEFG"); assert_ne!(mime.get_param(BOUNDARY).unwrap(), "abcdefg"); } #[test] fn test_get_param() { assert_eq!(TEXT_PLAIN.get_param("charset"), None); assert_eq!(TEXT_PLAIN.get_param("baz"), None); assert_eq!(TEXT_PLAIN_UTF_8.get_param("charset"), Some(UTF_8)); assert_eq!(TEXT_PLAIN_UTF_8.get_param("baz"), None); let mime = Mime::from_str("text/plain; charset=utf-8; foo=bar").unwrap(); assert_eq!(mime.get_param(CHARSET).unwrap(), "utf-8"); assert_eq!(mime.get_param("foo").unwrap(), "bar"); assert_eq!(mime.get_param("baz"), None); let mime = Mime::from_str("text/plain;charset=\"utf-8\"").unwrap(); assert_eq!(mime.get_param(CHARSET), Some(UTF_8)); } #[test] fn test_name_eq() { assert_eq!(TEXT, TEXT); assert_eq!(TEXT, "text"); assert_eq!("text", TEXT); assert_eq!(TEXT, "TEXT"); let param = Name { source: "ABC", insensitive: false, }; assert_eq!(param, param); assert_eq!(param, "ABC"); assert_eq!("ABC", param); assert_ne!(param, "abc"); assert_ne!("abc", param); } } mime-0.3.9/src/parse.rs010066400017500001750000000254441333334621600131610ustar0000000000000000#[allow(unused, deprecated)] use std::ascii::AsciiExt; use std::error::Error; use std::fmt; use std::iter::Enumerate; use std::str::Bytes; use super::{Mime, Source, ParamSource, Indexed, CHARSET, UTF_8}; #[derive(Debug)] pub enum ParseError { MissingSlash, MissingEqual, MissingQuote, InvalidToken { pos: usize, byte: u8, }, } impl Error for ParseError { fn description(&self) -> &str { use self::ParseError::*; match *self { MissingSlash => "a slash (/) was missing between the type and subtype", MissingEqual => "an equals sign (=) was missing between a parameter and its value", MissingQuote => "a quote (\") was missing from a parameter value", InvalidToken { .. } => "an invalid token was encountered", } } } impl fmt::Display for ParseError { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { if let ParseError::InvalidToken { pos, byte } = *self { write!(f, "{}, {:X} at position {}", self.description(), byte, pos) } else { f.write_str(self.description()) } } } pub fn parse(s: &str) -> Result { if s == "*/*" { return Ok(::STAR_STAR); } let mut iter = s.bytes().enumerate(); // toplevel let mut start; let slash; loop { match iter.next() { Some((_, c)) if is_token(c) => (), Some((i, b'/')) if i > 0 => { slash = i; start = i + 1; break; }, None => return Err(ParseError::MissingSlash), // EOF and no toplevel is no Mime Some((pos, byte)) => return Err(ParseError::InvalidToken { pos: pos, byte: byte, }) }; } // sublevel let mut plus = None; loop { match iter.next() { Some((i, b'+')) if i > start => { plus = Some(i); }, Some((i, b';')) if i > start => { start = i; break; }, Some((_, c)) if is_token(c) => (), None => { return Ok(Mime { source: Source::Dynamic(s.to_ascii_lowercase()), slash: slash, plus: plus, params: ParamSource::None, }); }, Some((pos, byte)) => return Err(ParseError::InvalidToken { pos: pos, byte: byte, }) }; } // params let params = try!(params_from_str(s, &mut iter, start)); let src = match params { ParamSource::Utf8(_) | ParamSource::None => s.to_ascii_lowercase(), ParamSource::Custom(semicolon, ref indices) => lower_ascii_with_params(s, semicolon, indices), }; Ok(Mime { source: Source::Dynamic(src), slash: slash, plus: plus, params: params, }) } fn params_from_str(s: &str, iter: &mut Enumerate, mut start: usize) -> Result { let semicolon = start; start += 1; let mut params = ParamSource::None; 'params: while start < s.len() { let name; // name 'name: loop { match iter.next() { Some((i, b' ')) if i == start => start = i + 1, Some((_, c)) if is_token(c) => (), Some((i, b'=')) if i > start => { name = Indexed(start, i); start = i + 1; break 'name; }, None => return Err(ParseError::MissingEqual), Some((pos, byte)) => return Err(ParseError::InvalidToken { pos: pos, byte: byte, }), } } let value; // values must be restrict-name-char or "anything goes" let mut is_quoted = false; 'value: loop { if is_quoted { match iter.next() { Some((i, b'"')) if i > start => { value = Indexed(start, i); break 'value; }, Some((_, c)) if is_restricted_quoted_char(c) => (), None => return Err(ParseError::MissingQuote), Some((pos, byte)) => return Err(ParseError::InvalidToken { pos: pos, byte: byte, }), } } else { match iter.next() { Some((i, b'"')) if i == start => { is_quoted = true; start = i + 1; }, Some((_, c)) if is_token(c) => (), Some((i, b';')) if i > start => { value = Indexed(start, i); start = i + 1; break 'value; } None => { value = Indexed(start, s.len()); start = s.len(); break 'value; }, Some((pos, byte)) => return Err(ParseError::InvalidToken { pos: pos, byte: byte, }), } } } if is_quoted { 'ws: loop { match iter.next() { Some((i, b';')) => { // next param start = i + 1; break 'ws; }, Some((_, b' ')) => { // skip whitespace }, None => { // eof start = s.len(); break 'ws; }, Some((pos, byte)) => return Err(ParseError::InvalidToken { pos: pos, byte: byte, }), } } } match params { ParamSource::Utf8(i) => { let i = i + 2; let charset = Indexed(i, "charset".len() + i); let utf8 = Indexed(charset.1 + 1, charset.1 + "utf-8".len() + 1); params = ParamSource::Custom(semicolon, vec![ (charset, utf8), (name, value), ]); }, ParamSource::Custom(_, ref mut vec) => { vec.push((name, value)); }, ParamSource::None => { if semicolon + 2 == name.0 && CHARSET == &s[name.0..name.1] { if UTF_8 == &s[value.0..value.1] { params = ParamSource::Utf8(semicolon); continue 'params; } } params = ParamSource::Custom(semicolon, vec![(name, value)]); }, } } Ok(params) } fn lower_ascii_with_params(s: &str, semi: usize, params: &[(Indexed, Indexed)]) -> String { let mut owned = s.to_owned(); owned[..semi].make_ascii_lowercase(); for &(ref name, ref value) in params { owned[name.0..name.1].make_ascii_lowercase(); // Since we just converted this part of the string to lowercase, // we can skip the `Name == &str` unicase check and do a faster // memcmp instead. if &owned[name.0..name.1] == CHARSET.source { owned[value.0..value.1].make_ascii_lowercase(); } } owned } // From [RFC6838](http://tools.ietf.org/html/rfc6838#section-4.2): // // > All registered media types MUST be assigned top-level type and // > subtype names. The combination of these names serves to uniquely // > identify the media type, and the subtype name facet (or the absence // > of one) identifies the registration tree. Both top-level type and // > subtype names are case-insensitive. // > // > Type and subtype names MUST conform to the following ABNF: // > // > type-name = restricted-name // > subtype-name = restricted-name // > // > restricted-name = restricted-name-first *126restricted-name-chars // > restricted-name-first = ALPHA / DIGIT // > restricted-name-chars = ALPHA / DIGIT / "!" / "#" / // > "$" / "&" / "-" / "^" / "_" // > restricted-name-chars =/ "." ; Characters before first dot always // > ; specify a facet name // > restricted-name-chars =/ "+" ; Characters after last plus always // > ; specify a structured syntax suffix // However, [HTTP](https://tools.ietf.org/html/rfc7231#section-3.1.1.1): // // > media-type = type "/" subtype *( OWS ";" OWS parameter ) // > type = token // > subtype = token // > parameter = token "=" ( token / quoted-string ) // // Where token is defined as: // // > token = 1*tchar // > tchar = "!" / "#" / "$" / "%" / "&" / "'" / "*" / "+" / "-" / "." / // > "^" / "_" / "`" / "|" / "~" / DIGIT / ALPHA // // So, clearly, ¯\_(Ä_/¯ macro_rules! byte_map { ($($flag:expr,)*) => ([ $($flag != 0,)* ]) } static TOKEN_MAP: [bool; 256] = byte_map![ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0, 1, 1, 1, 1, 1, 0, 0, 1, 1, 0, 1, 1, 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 1, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, ]; fn is_token(c: u8) -> bool { TOKEN_MAP[c as usize] } fn is_restricted_quoted_char(c: u8) -> bool { c > 31 && c != 127 } #[test] fn test_lookup_tables() { for (i, &valid) in TOKEN_MAP.iter().enumerate() { let i = i as u8; let should = match i { b'a'...b'z' | b'A'...b'Z' | b'0'...b'9' | b'!' | b'#' | b'$' | b'%' | b'&' | b'\'' | b'*' | b'+' | b'-' | b'.' | b'^' | b'_' | b'`' | b'|' | b'~' => true, _ => false }; assert_eq!(valid, should, "{:?} ({}) should be {}", i as char, i, should); } }