servius/rapr-rs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
gh-pages
rapr-rs/docs/mime/index.html
T
github-actions[bot] a4995c672b Auto Generated Documentation
2021-03-26 19:20:48 +00:00

100 lines
20 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!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="API documentation for the Rust `mime` crate."><meta name="keywords" content="rust, rustlang, rust-lang, mime"><title>mime - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings"></script><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg">
<link rel="alternate icon" type="image/png" href="../favicon-16x16.png">
<link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><a href='../mime/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><p class="location">Crate mime</p><div class="block version"><p>Version 0.3.16</p></div><div class="sidebar-elems"><a id="all-types" href="all.html"><p>See all mime's items</p></a><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#constants">Constants</a></li></ul></div><p class="location"></p><div id="sidebar-vars" data-name="mime" data-ty="mod" data-relpath="../"></div></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Crate <a class="mod" href="">mime</a></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span><a class="srclink" href="../src/mime/lib.rs.html#1-937" title="goto source code">[src]</a></span></h1><div class="docblock"><h1 id="mime" class="section-header"><a href="#mime">Mime</a></h1>
<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>
<h2 id="what-is-mime" class="section-header"><a href="#what-is-mime">What is Mime?</a></h2>
<p>Example mime string: <code>text/plain</code></p>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">let</span> <span class="ident">plain_text</span>: <span class="ident">mime</span>::<span class="ident">Mime</span> <span class="op">=</span> <span class="string">&quot;text/plain&quot;</span>.<span class="ident">parse</span>().<span class="ident">unwrap</span>();
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">plain_text</span>, <span class="ident">mime</span>::<span class="ident">TEXT_PLAIN</span>);</pre></div>
<h2 id="inspecting-mimes" class="section-header"><a href="#inspecting-mimes">Inspecting Mimes</a></h2>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">let</span> <span class="ident">mime</span> <span class="op">=</span> <span class="ident">mime</span>::<span class="ident">TEXT_PLAIN</span>;
<span class="kw">match</span> (<span class="ident">mime</span>.<span class="ident">type_</span>(), <span class="ident">mime</span>.<span class="ident">subtype</span>()) {
(<span class="ident">mime</span>::<span class="ident">TEXT</span>, <span class="ident">mime</span>::<span class="ident">PLAIN</span>) <span class="op">=</span><span class="op">&gt;</span> <span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;plain text!&quot;</span>),
(<span class="ident">mime</span>::<span class="ident">TEXT</span>, <span class="kw">_</span>) <span class="op">=</span><span class="op">&gt;</span> <span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;structured text&quot;</span>),
<span class="kw">_</span> <span class="op">=</span><span class="op">&gt;</span> <span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;not text&quot;</span>),
}</pre></div>
</div><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2>
<table><tr class="module-item"><td><a class="struct" href="struct.FromStrError.html" title="mime::FromStrError struct">FromStrError</a></td><td class="docblock-short"><p>An error when parsing a <code>Mime</code> from a string.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Mime.html" title="mime::Mime struct">Mime</a></td><td class="docblock-short"><p>A parsed mime or media type.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Name.html" title="mime::Name struct">Name</a></td><td class="docblock-short"><p>A section of a <code>Mime</code>.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Params.html" title="mime::Params struct">Params</a></td><td class="docblock-short"><p>An iterator over the parameters of a MIME.</p>
</td></tr></table><h2 id="constants" class="section-header"><a href="#constants">Constants</a></h2>
<table><tr class="module-item"><td><a class="constant" href="constant.APPLICATION.html" title="mime::APPLICATION constant">APPLICATION</a></td><td class="docblock-short"><p>application</p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.APPLICATION_JAVASCRIPT.html" title="mime::APPLICATION_JAVASCRIPT constant">APPLICATION_JAVASCRIPT</a></td><td class="docblock-short"><p><code>application/javascript</code></p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.APPLICATION_JAVASCRIPT_UTF_8.html" title="mime::APPLICATION_JAVASCRIPT_UTF_8 constant">APPLICATION_JAVASCRIPT_UTF_8</a></td><td class="docblock-short"><p><code>application/javascript; charset=utf-8</code></p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.APPLICATION_JSON.html" title="mime::APPLICATION_JSON constant">APPLICATION_JSON</a></td><td class="docblock-short"><p><code>application/json</code></p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.APPLICATION_MSGPACK.html" title="mime::APPLICATION_MSGPACK constant">APPLICATION_MSGPACK</a></td><td class="docblock-short"><p><code>application/msgpack</code></p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.APPLICATION_OCTET_STREAM.html" title="mime::APPLICATION_OCTET_STREAM constant">APPLICATION_OCTET_STREAM</a></td><td class="docblock-short"><p><code>application/octet-stream</code></p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.APPLICATION_PDF.html" title="mime::APPLICATION_PDF constant">APPLICATION_PDF</a></td><td class="docblock-short"><p><code>application/pdf</code></p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.APPLICATION_WWW_FORM_URLENCODED.html" title="mime::APPLICATION_WWW_FORM_URLENCODED constant">APPLICATION_WWW_FORM_URLENCODED</a></td><td class="docblock-short"><p><code>application/x-www-form-urlencoded</code></p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.AUDIO.html" title="mime::AUDIO constant">AUDIO</a></td><td class="docblock-short"><p>audio</p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.BASIC.html" title="mime::BASIC constant">BASIC</a></td><td class="docblock-short"><p>basic</p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.BMP.html" title="mime::BMP constant">BMP</a></td><td class="docblock-short"><p>bmp</p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.BOUNDARY.html" title="mime::BOUNDARY constant">BOUNDARY</a></td><td class="docblock-short"><p>boundary</p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.CHARSET.html" title="mime::CHARSET constant">CHARSET</a></td><td class="docblock-short"><p>charset</p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.CSS.html" title="mime::CSS constant">CSS</a></td><td class="docblock-short"><p>css</p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.CSV.html" title="mime::CSV constant">CSV</a></td><td class="docblock-short"><p>csv</p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.EVENT_STREAM.html" title="mime::EVENT_STREAM constant">EVENT_STREAM</a></td><td class="docblock-short"><p>event-stream</p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.FONT.html" title="mime::FONT constant">FONT</a></td><td class="docblock-short"><p>font</p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.FONT_WOFF.html" title="mime::FONT_WOFF constant">FONT_WOFF</a></td><td class="docblock-short"><p><code>font/woff</code></p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.FONT_WOFF2.html" title="mime::FONT_WOFF2 constant">FONT_WOFF2</a></td><td class="docblock-short"><p><code>font/woff2</code></p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.FORM_DATA.html" title="mime::FORM_DATA constant">FORM_DATA</a></td><td class="docblock-short"><p>form-data</p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.GIF.html" title="mime::GIF constant">GIF</a></td><td class="docblock-short"><p>gif</p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.HTML.html" title="mime::HTML constant">HTML</a></td><td class="docblock-short"><p>html</p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.IMAGE.html" title="mime::IMAGE constant">IMAGE</a></td><td class="docblock-short"><p>image</p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.IMAGE_BMP.html" title="mime::IMAGE_BMP constant">IMAGE_BMP</a></td><td class="docblock-short"><p><code>image/bmp</code></p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.IMAGE_GIF.html" title="mime::IMAGE_GIF constant">IMAGE_GIF</a></td><td class="docblock-short"><p><code>image/gif</code></p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.IMAGE_JPEG.html" title="mime::IMAGE_JPEG constant">IMAGE_JPEG</a></td><td class="docblock-short"><p><code>image/jpeg</code></p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.IMAGE_PNG.html" title="mime::IMAGE_PNG constant">IMAGE_PNG</a></td><td class="docblock-short"><p><code>image/png</code></p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.IMAGE_STAR.html" title="mime::IMAGE_STAR constant">IMAGE_STAR</a></td><td class="docblock-short"><p><code>image/*</code></p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.IMAGE_SVG.html" title="mime::IMAGE_SVG constant">IMAGE_SVG</a></td><td class="docblock-short"><p><code>image/svg+xml</code></p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.JAVASCRIPT.html" title="mime::JAVASCRIPT constant">JAVASCRIPT</a></td><td class="docblock-short"><p>javascript</p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.JPEG.html" title="mime::JPEG constant">JPEG</a></td><td class="docblock-short"><p>jpeg</p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.JSON.html" title="mime::JSON constant">JSON</a></td><td class="docblock-short"><p>json</p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.MESSAGE.html" title="mime::MESSAGE constant">MESSAGE</a></td><td class="docblock-short"><p>message</p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.MODEL.html" title="mime::MODEL constant">MODEL</a></td><td class="docblock-short"><p>model</p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.MP4.html" title="mime::MP4 constant">MP4</a></td><td class="docblock-short"><p>mp4</p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.MPEG.html" title="mime::MPEG constant">MPEG</a></td><td class="docblock-short"><p>mpeg</p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.MSGPACK.html" title="mime::MSGPACK constant">MSGPACK</a></td><td class="docblock-short"><p>msgpack</p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.MULTIPART.html" title="mime::MULTIPART constant">MULTIPART</a></td><td class="docblock-short"><p>multipart</p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.MULTIPART_FORM_DATA.html" title="mime::MULTIPART_FORM_DATA constant">MULTIPART_FORM_DATA</a></td><td class="docblock-short"><p><code>multipart/form-data</code></p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.OCTET_STREAM.html" title="mime::OCTET_STREAM constant">OCTET_STREAM</a></td><td class="docblock-short"><p>octet-stream</p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.OGG.html" title="mime::OGG constant">OGG</a></td><td class="docblock-short"><p>ogg</p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.PDF.html" title="mime::PDF constant">PDF</a></td><td class="docblock-short"><p>pdf</p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.PLAIN.html" title="mime::PLAIN constant">PLAIN</a></td><td class="docblock-short"><p>plain</p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.PNG.html" title="mime::PNG constant">PNG</a></td><td class="docblock-short"><p>png</p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.STAR.html" title="mime::STAR constant">STAR</a></td><td class="docblock-short"><p>
<li></li>
</p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.STAR_STAR.html" title="mime::STAR_STAR constant">STAR_STAR</a></td><td class="docblock-short"><p><code>*/*</code></p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.SVG.html" title="mime::SVG constant">SVG</a></td><td class="docblock-short"><p>svg</p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.TEXT.html" title="mime::TEXT constant">TEXT</a></td><td class="docblock-short"><p>text</p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.TEXT_CSS.html" title="mime::TEXT_CSS constant">TEXT_CSS</a></td><td class="docblock-short"><p><code>text/css</code></p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.TEXT_CSS_UTF_8.html" title="mime::TEXT_CSS_UTF_8 constant">TEXT_CSS_UTF_8</a></td><td class="docblock-short"><p><code>text/css; charset=utf-8</code></p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.TEXT_CSV.html" title="mime::TEXT_CSV constant">TEXT_CSV</a></td><td class="docblock-short"><p><code>text/csv</code></p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.TEXT_CSV_UTF_8.html" title="mime::TEXT_CSV_UTF_8 constant">TEXT_CSV_UTF_8</a></td><td class="docblock-short"><p><code>text/csv; charset=utf-8</code></p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.TEXT_EVENT_STREAM.html" title="mime::TEXT_EVENT_STREAM constant">TEXT_EVENT_STREAM</a></td><td class="docblock-short"><p><code>text/event-stream</code></p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.TEXT_HTML.html" title="mime::TEXT_HTML constant">TEXT_HTML</a></td><td class="docblock-short"><p><code>text/html</code></p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.TEXT_HTML_UTF_8.html" title="mime::TEXT_HTML_UTF_8 constant">TEXT_HTML_UTF_8</a></td><td class="docblock-short"><p><code>text/html; charset=utf-8</code></p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.TEXT_JAVASCRIPT.html" title="mime::TEXT_JAVASCRIPT constant">TEXT_JAVASCRIPT</a></td><td class="docblock-short"><p><code>text/javascript</code></p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.TEXT_PLAIN.html" title="mime::TEXT_PLAIN constant">TEXT_PLAIN</a></td><td class="docblock-short"><p><code>text/plain</code></p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.TEXT_PLAIN_UTF_8.html" title="mime::TEXT_PLAIN_UTF_8 constant">TEXT_PLAIN_UTF_8</a></td><td class="docblock-short"><p><code>text/plain; charset=utf-8</code></p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.TEXT_STAR.html" title="mime::TEXT_STAR constant">TEXT_STAR</a></td><td class="docblock-short"><p><code>text/*</code></p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.TEXT_TAB_SEPARATED_VALUES.html" title="mime::TEXT_TAB_SEPARATED_VALUES constant">TEXT_TAB_SEPARATED_VALUES</a></td><td class="docblock-short"><p><code>text/tab-separated-values</code></p>
</td></tr><tr class="module-item"><td><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></td><td class="docblock-short"><p><code>text/tab-separated-values; charset=utf-8</code></p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.TEXT_VCARD.html" title="mime::TEXT_VCARD constant">TEXT_VCARD</a></td><td class="docblock-short"><p><code>text/vcard</code></p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.TEXT_XML.html" title="mime::TEXT_XML constant">TEXT_XML</a></td><td class="docblock-short"><p><code>text/xml</code></p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.UTF_8.html" title="mime::UTF_8 constant">UTF_8</a></td><td class="docblock-short"><p>utf-8</p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.VCARD.html" title="mime::VCARD constant">VCARD</a></td><td class="docblock-short"><p>vcard</p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.VIDEO.html" title="mime::VIDEO constant">VIDEO</a></td><td class="docblock-short"><p>video</p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.WOFF.html" title="mime::WOFF constant">WOFF</a></td><td class="docblock-short"><p>woff</p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.WOFF2.html" title="mime::WOFF2 constant">WOFF2</a></td><td class="docblock-short"><p>woff2</p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.WWW_FORM_URLENCODED.html" title="mime::WWW_FORM_URLENCODED constant">WWW_FORM_URLENCODED</a></td><td class="docblock-short"><p>x-www-form-urlencoded</p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.XML.html" title="mime::XML constant">XML</a></td><td class="docblock-short"><p>xml</p>
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../" data-current-crate="mime"></div>
<script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>
Reference in New Issue View Git Blame Copy Permalink