juniper/mime/index.html

178 lines
7.5 KiB
HTML
Raw Normal View History

2016-09-11 13:41:24 -05:00
<!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="../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../main.css">
</head>
<body class="rustdoc">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<p class='location'></p><script>window.sidebarCurrent = {name: 'mime', ty: 'mod', relpath: '../'};</script>
</nav>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press S to search, ? for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content mod">
<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 id='src-0' class='srclink' href='../src/mime/lib.rs.html#1-613' 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;charset=utf-8</code></p>
<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;charset=utf-8&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='macro'>mime</span><span class='macro'>!</span>(<span class='ident'>Text</span><span class='op'>/</span><span class='ident'>Plain</span>; <span class='ident'>Charset</span><span class='op'>=</span><span class='ident'>Utf8</span>));</pre>
</div><h2 id='macros' class='section-header'><a href="#macros">Macros</a></h2>
<table>
<tr class=' module-item'>
<td><a class='macro' href='macro.mime!.html'
title='mime::mime!'>mime!</a></td>
<td class='docblock short'>
<p>Easily create a Mime without having to import so many enums.</p>
</td>
</tr></table><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table>
<tr class=' module-item'>
<td><a class='struct' href='struct.Mime.html'
title='mime::Mime'>Mime</a></td>
<td class='docblock short'>
<p>Mime, or Media Type. Encapsulates common registers types.</p>
</td>
</tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
<table>
<tr class=' module-item'>
<td><a class='enum' href='enum.Attr.html'
title='mime::Attr'>Attr</a></td>
<td class='docblock short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class='enum' href='enum.SubLevel.html'
title='mime::SubLevel'>SubLevel</a></td>
<td class='docblock short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class='enum' href='enum.TopLevel.html'
title='mime::TopLevel'>TopLevel</a></td>
<td class='docblock short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class='enum' href='enum.Value.html'
title='mime::Value'>Value</a></td>
<td class='docblock short'>
</td>
</tr></table><h2 id='types' class='section-header'><a href="#types">Type Definitions</a></h2>
<table>
<tr class=' module-item'>
<td><a class='type' href='type.Param.html'
title='mime::Param'>Param</a></td>
<td class='docblock short'>
</td>
</tr></table></section>
<section id='search' class="content hidden"></section>
<section class="footer"></section>
<aside id="help" class="hidden">
<div>
<h1 class="hidden">Help</h1>
<div class="shortcuts">
<h2>Keyboard Shortcuts</h2>
<dl>
<dt>?</dt>
<dd>Show this help dialog</dd>
<dt>S</dt>
<dd>Focus the search field</dd>
<dt>&larrb;</dt>
<dd>Move up in search results</dd>
<dt>&rarrb;</dt>
<dd>Move down in search results</dd>
<dt>&#9166;</dt>
<dd>Go to active search result</dd>
<dt>+</dt>
<dd>Collapse/expand all sections</dd>
</dl>
</div>
<div class="infos">
<h2>Search Tricks</h2>
<p>
Prefix searches with a type followed by a colon (e.g.
<code>fn:</code>) to restrict the search to a given type.
</p>
<p>
Accepted types are: <code>fn</code>, <code>mod</code>,
<code>struct</code>, <code>enum</code>,
<code>trait</code>, <code>type</code>, <code>macro</code>,
and <code>const</code>.
</p>
<p>
Search functions by type signature (e.g.
<code>vec -> usize</code> or <code>* -> vec</code>)
</p>
</div>
</div>
</aside>
<script>
window.rootPath = "../";
window.currentCrate = "mime";
window.playgroundUrl = "";
</script>
<script src="../jquery.js"></script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>