blob: 033354169c09c1380d7f4a0fa1479e9090c0f939 [file] [log] [blame]
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Mime"><meta name="keywords" content="rust, rustlang, rust-lang, mime"><title>mime - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../normalize.css"><link rel="stylesheet" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../ayu.css" disabled><link rel="stylesheet" href="../dark.css" disabled><link rel="stylesheet" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="../crates.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../mime/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../mime/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Crate mime</a></h2><div class="sidebar-elems"><ul class="block"><li class="version">Version 0.3.17</li><li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#constants">Constants</a></li></ul></section></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Crate <a class="mod" href="#">mime</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../src/mime/lib.rs.html#1-944">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><h2 id="mime"><a href="#mime">Mime</a></h2>
<p>Mime is now Media Type, technically, but <code>Mime</code> is more immediately
understandable, so the main type here is <code>Mime</code>.</p>
<h3 id="what-is-mime"><a href="#what-is-mime">What is Mime?</a></h3>
<p>Example mime string: <code>text/plain</code></p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>plain_text: mime::Mime = <span class="string">&quot;text/plain&quot;</span>.parse().unwrap();
<span class="macro">assert_eq!</span>(plain_text, mime::TEXT_PLAIN);</code></pre></div>
<h3 id="inspecting-mimes"><a href="#inspecting-mimes">Inspecting Mimes</a></h3>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>mime = mime::TEXT_PLAIN;
<span class="kw">match </span>(mime.type_(), mime.subtype()) {
(mime::TEXT, mime::PLAIN) =&gt; <span class="macro">println!</span>(<span class="string">&quot;plain text!&quot;</span>),
(mime::TEXT, <span class="kw">_</span>) =&gt; <span class="macro">println!</span>(<span class="string">&quot;structured text&quot;</span>),
<span class="kw">_ </span>=&gt; <span class="macro">println!</span>(<span class="string">&quot;not text&quot;</span>),
}</code></pre></div>
</div></details><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.FromStrError.html" title="mime::FromStrError struct">FromStrError</a></div><div class="item-right docblock-short">An error when parsing a <code>Mime</code> from a string.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Mime.html" title="mime::Mime struct">Mime</a></div><div class="item-right docblock-short">A parsed mime or media type.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.MimeIter.html" title="mime::MimeIter struct">MimeIter</a></div><div class="item-right docblock-short">An iterator of parsed mime</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Name.html" title="mime::Name struct">Name</a></div><div class="item-right docblock-short">A section of a <code>Mime</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Params.html" title="mime::Params struct">Params</a></div><div class="item-right docblock-short">An iterator over the parameters of a MIME.</div></div></div><h2 id="constants" class="small-section-header"><a href="#constants">Constants</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.APPLICATION.html" title="mime::APPLICATION constant">APPLICATION</a></div><div class="item-right docblock-short">application</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.APPLICATION_JAVASCRIPT.html" title="mime::APPLICATION_JAVASCRIPT constant">APPLICATION_JAVASCRIPT</a></div><div class="item-right docblock-short"><code>application/javascript</code></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.APPLICATION_JAVASCRIPT_UTF_8.html" title="mime::APPLICATION_JAVASCRIPT_UTF_8 constant">APPLICATION_JAVASCRIPT_UTF_8</a></div><div class="item-right docblock-short"><code>application/javascript; charset=utf-8</code></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.APPLICATION_JSON.html" title="mime::APPLICATION_JSON constant">APPLICATION_JSON</a></div><div class="item-right docblock-short"><code>application/json</code></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.APPLICATION_MSGPACK.html" title="mime::APPLICATION_MSGPACK constant">APPLICATION_MSGPACK</a></div><div class="item-right docblock-short"><code>application/msgpack</code></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.APPLICATION_OCTET_STREAM.html" title="mime::APPLICATION_OCTET_STREAM constant">APPLICATION_OCTET_STREAM</a></div><div class="item-right docblock-short"><code>application/octet-stream</code></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.APPLICATION_PDF.html" title="mime::APPLICATION_PDF constant">APPLICATION_PDF</a></div><div class="item-right docblock-short"><code>application/pdf</code></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.APPLICATION_WWW_FORM_URLENCODED.html" title="mime::APPLICATION_WWW_FORM_URLENCODED constant">APPLICATION_WWW_FORM_URLENCODED</a></div><div class="item-right docblock-short"><code>application/x-www-form-urlencoded</code></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.AUDIO.html" title="mime::AUDIO constant">AUDIO</a></div><div class="item-right docblock-short">audio</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.BASIC.html" title="mime::BASIC constant">BASIC</a></div><div class="item-right docblock-short">basic</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.BMP.html" title="mime::BMP constant">BMP</a></div><div class="item-right docblock-short">bmp</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.BOUNDARY.html" title="mime::BOUNDARY constant">BOUNDARY</a></div><div class="item-right docblock-short">boundary</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.CHARSET.html" title="mime::CHARSET constant">CHARSET</a></div><div class="item-right docblock-short">charset</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.CSS.html" title="mime::CSS constant">CSS</a></div><div class="item-right docblock-short">css</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.CSV.html" title="mime::CSV constant">CSV</a></div><div class="item-right docblock-short">csv</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.EVENT_STREAM.html" title="mime::EVENT_STREAM constant">EVENT_STREAM</a></div><div class="item-right docblock-short">event-stream</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.FONT.html" title="mime::FONT constant">FONT</a></div><div class="item-right docblock-short">font</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.FONT_WOFF.html" title="mime::FONT_WOFF constant">FONT_WOFF</a></div><div class="item-right docblock-short"><code>font/woff</code></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.FONT_WOFF2.html" title="mime::FONT_WOFF2 constant">FONT_WOFF2</a></div><div class="item-right docblock-short"><code>font/woff2</code></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.FORM_DATA.html" title="mime::FORM_DATA constant">FORM_DATA</a></div><div class="item-right docblock-short">form-data</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.GIF.html" title="mime::GIF constant">GIF</a></div><div class="item-right docblock-short">gif</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.HTML.html" title="mime::HTML constant">HTML</a></div><div class="item-right docblock-short">html</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.IMAGE.html" title="mime::IMAGE constant">IMAGE</a></div><div class="item-right docblock-short">image</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.IMAGE_BMP.html" title="mime::IMAGE_BMP constant">IMAGE_BMP</a></div><div class="item-right docblock-short"><code>image/bmp</code></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.IMAGE_GIF.html" title="mime::IMAGE_GIF constant">IMAGE_GIF</a></div><div class="item-right docblock-short"><code>image/gif</code></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.IMAGE_JPEG.html" title="mime::IMAGE_JPEG constant">IMAGE_JPEG</a></div><div class="item-right docblock-short"><code>image/jpeg</code></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.IMAGE_PNG.html" title="mime::IMAGE_PNG constant">IMAGE_PNG</a></div><div class="item-right docblock-short"><code>image/png</code></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.IMAGE_STAR.html" title="mime::IMAGE_STAR constant">IMAGE_STAR</a></div><div class="item-right docblock-short"><code>image/*</code></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.IMAGE_SVG.html" title="mime::IMAGE_SVG constant">IMAGE_SVG</a></div><div class="item-right docblock-short"><code>image/svg+xml</code></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.JAVASCRIPT.html" title="mime::JAVASCRIPT constant">JAVASCRIPT</a></div><div class="item-right docblock-short">javascript</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.JPEG.html" title="mime::JPEG constant">JPEG</a></div><div class="item-right docblock-short">jpeg</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.JSON.html" title="mime::JSON constant">JSON</a></div><div class="item-right docblock-short">json</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.MESSAGE.html" title="mime::MESSAGE constant">MESSAGE</a></div><div class="item-right docblock-short">message</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.MODEL.html" title="mime::MODEL constant">MODEL</a></div><div class="item-right docblock-short">model</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.MP4.html" title="mime::MP4 constant">MP4</a></div><div class="item-right docblock-short">mp4</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.MPEG.html" title="mime::MPEG constant">MPEG</a></div><div class="item-right docblock-short">mpeg</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.MSGPACK.html" title="mime::MSGPACK constant">MSGPACK</a></div><div class="item-right docblock-short">msgpack</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.MULTIPART.html" title="mime::MULTIPART constant">MULTIPART</a></div><div class="item-right docblock-short">multipart</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.MULTIPART_FORM_DATA.html" title="mime::MULTIPART_FORM_DATA constant">MULTIPART_FORM_DATA</a></div><div class="item-right docblock-short"><code>multipart/form-data</code></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.OCTET_STREAM.html" title="mime::OCTET_STREAM constant">OCTET_STREAM</a></div><div class="item-right docblock-short">octet-stream</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.OGG.html" title="mime::OGG constant">OGG</a></div><div class="item-right docblock-short">ogg</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.PDF.html" title="mime::PDF constant">PDF</a></div><div class="item-right docblock-short">pdf</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.PLAIN.html" title="mime::PLAIN constant">PLAIN</a></div><div class="item-right docblock-short">plain</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.PNG.html" title="mime::PNG constant">PNG</a></div><div class="item-right docblock-short">png</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.STAR.html" title="mime::STAR constant">STAR</a></div><div class="item-right docblock-short"><li></li>
</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.STAR_STAR.html" title="mime::STAR_STAR constant">STAR_STAR</a></div><div class="item-right docblock-short"><code>*/*</code></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.SVG.html" title="mime::SVG constant">SVG</a></div><div class="item-right docblock-short">svg</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.TEXT.html" title="mime::TEXT constant">TEXT</a></div><div class="item-right docblock-short">text</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.TEXT_CSS.html" title="mime::TEXT_CSS constant">TEXT_CSS</a></div><div class="item-right docblock-short"><code>text/css</code></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.TEXT_CSS_UTF_8.html" title="mime::TEXT_CSS_UTF_8 constant">TEXT_CSS_UTF_8</a></div><div class="item-right docblock-short"><code>text/css; charset=utf-8</code></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.TEXT_CSV.html" title="mime::TEXT_CSV constant">TEXT_CSV</a></div><div class="item-right docblock-short"><code>text/csv</code></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.TEXT_CSV_UTF_8.html" title="mime::TEXT_CSV_UTF_8 constant">TEXT_CSV_UTF_8</a></div><div class="item-right docblock-short"><code>text/csv; charset=utf-8</code></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.TEXT_EVENT_STREAM.html" title="mime::TEXT_EVENT_STREAM constant">TEXT_EVENT_STREAM</a></div><div class="item-right docblock-short"><code>text/event-stream</code></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.TEXT_HTML.html" title="mime::TEXT_HTML constant">TEXT_HTML</a></div><div class="item-right docblock-short"><code>text/html</code></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.TEXT_HTML_UTF_8.html" title="mime::TEXT_HTML_UTF_8 constant">TEXT_HTML_UTF_8</a></div><div class="item-right docblock-short"><code>text/html; charset=utf-8</code></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.TEXT_JAVASCRIPT.html" title="mime::TEXT_JAVASCRIPT constant">TEXT_JAVASCRIPT</a></div><div class="item-right docblock-short"><code>text/javascript</code></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.TEXT_PLAIN.html" title="mime::TEXT_PLAIN constant">TEXT_PLAIN</a></div><div class="item-right docblock-short"><code>text/plain</code></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.TEXT_PLAIN_UTF_8.html" title="mime::TEXT_PLAIN_UTF_8 constant">TEXT_PLAIN_UTF_8</a></div><div class="item-right docblock-short"><code>text/plain; charset=utf-8</code></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.TEXT_STAR.html" title="mime::TEXT_STAR constant">TEXT_STAR</a></div><div class="item-right docblock-short"><code>text/*</code></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.TEXT_TAB_SEPARATED_VALUES.html" title="mime::TEXT_TAB_SEPARATED_VALUES constant">TEXT_TAB_SEPARATED_VALUES</a></div><div class="item-right docblock-short"><code>text/tab-separated-values</code></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.TEXT_TAB_SEPARATED_VALUES_UTF_8.html" title="mime::TEXT_TAB_SEPARATED_VALUES_UTF_8 constant">TEXT_TAB_SEPARATED_VALUES_UTF_8</a></div><div class="item-right docblock-short"><code>text/tab-separated-values; charset=utf-8</code></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.TEXT_VCARD.html" title="mime::TEXT_VCARD constant">TEXT_VCARD</a></div><div class="item-right docblock-short"><code>text/vcard</code></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.TEXT_XML.html" title="mime::TEXT_XML constant">TEXT_XML</a></div><div class="item-right docblock-short"><code>text/xml</code></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.UTF_8.html" title="mime::UTF_8 constant">UTF_8</a></div><div class="item-right docblock-short">utf-8</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.VCARD.html" title="mime::VCARD constant">VCARD</a></div><div class="item-right docblock-short">vcard</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.VIDEO.html" title="mime::VIDEO constant">VIDEO</a></div><div class="item-right docblock-short">video</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.WOFF.html" title="mime::WOFF constant">WOFF</a></div><div class="item-right docblock-short">woff</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.WOFF2.html" title="mime::WOFF2 constant">WOFF2</a></div><div class="item-right docblock-short">woff2</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.WWW_FORM_URLENCODED.html" title="mime::WWW_FORM_URLENCODED constant">WWW_FORM_URLENCODED</a></div><div class="item-right docblock-short">x-www-form-urlencoded</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.XML.html" title="mime::XML constant">XML</a></div><div class="item-right docblock-short">xml</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="mime" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>