208 lines
No EOL
12 KiB
HTML
208 lines
No EOL
12 KiB
HTML
<!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 `language_tags` crate.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, language_tags">
|
||
|
||
<title>language_tags - 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="../dark.css">
|
||
<link rel="stylesheet" type="text/css" href="../main.css" id="themeStyle">
|
||
<script src="../storage.js"></script>
|
||
|
||
|
||
|
||
|
||
</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">☰</div>
|
||
|
||
<p class='location'>Crate language_tags</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#macros">Macros</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#constants">Constants</a></li><li><a href="#types">Type Definitions</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'language_tags', ty: 'mod', relpath: '../'};</script></div>
|
||
</nav>
|
||
|
||
<div class="theme-picker">
|
||
<button id="theme-picker" aria-label="Pick another theme!">
|
||
<img src="../brush.svg" width="18" alt="Pick another theme!">
|
||
</button>
|
||
<div id="theme-choices"></div>
|
||
</div>
|
||
<script src="../theme.js"></script>
|
||
<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">
|
||
<h1 class='fqn'><span class='in-band'>Crate <a class="mod" href=''>language_tags</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'>−</span>]
|
||
</a>
|
||
</span><a class='srclink' href='../src/language_tags/lib.rs.html#1-640' title='goto source code'>[src]</a></span></h1>
|
||
<div class='docblock'><p>Language tags can be used identify human languages, scripts e.g. Latin script, countries and
|
||
other regions.</p>
|
||
<p>Language tags are defined in <a href="http://tools.ietf.org/html/bcp47">BCP47</a>, an introduction is
|
||
<a href="http://www.w3.org/International/articles/language-tags/">"Language tags in HTML and XML"</a> by
|
||
the W3C. They are commonly used in HTML and HTTP <code>Content-Language</code> and <code>Accept-Language</code>
|
||
header fields.</p>
|
||
<p>This package currently supports parsing (fully conformant parser), formatting and comparing
|
||
language tags.</p>
|
||
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
||
<p>Create a simple language tag representing the French language as spoken
|
||
in Belgium and print it:</p>
|
||
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">language_tags</span>::<span class="ident">LanguageTag</span>;
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">langtag</span>: <span class="ident">LanguageTag</span> <span class="op">=</span> <span class="ident">Default</span>::<span class="ident">default</span>();
|
||
<span class="ident">langtag</span>.<span class="ident">language</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="string">"fr"</span>.<span class="ident">to_owned</span>());
|
||
<span class="ident">langtag</span>.<span class="ident">region</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="string">"BE"</span>.<span class="ident">to_owned</span>());
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="macro">format</span><span class="macro">!</span>(<span class="string">"{}"</span>, <span class="ident">langtag</span>), <span class="string">"fr-BE"</span>);</pre>
|
||
<p>Parse a tag representing a special type of English specified by private agreement:</p>
|
||
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">language_tags</span>::<span class="ident">LanguageTag</span>;
|
||
<span class="kw">let</span> <span class="ident">langtag</span>: <span class="ident">LanguageTag</span> <span class="op">=</span> <span class="string">"en-x-twain"</span>.<span class="ident">parse</span>().<span class="ident">unwrap</span>();
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="macro">format</span><span class="macro">!</span>(<span class="string">"{}"</span>, <span class="ident">langtag</span>.<span class="ident">language</span>.<span class="ident">unwrap</span>()), <span class="string">"en"</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="macro">format</span><span class="macro">!</span>(<span class="string">"{:?}"</span>, <span class="ident">langtag</span>.<span class="ident">privateuse</span>), <span class="string">"[\"twain\"]"</span>);</pre>
|
||
<p>You can check for equality, but more often you should test if two tags match.</p>
|
||
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">language_tags</span>::<span class="ident">LanguageTag</span>;
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">langtag_server</span>: <span class="ident">LanguageTag</span> <span class="op">=</span> <span class="ident">Default</span>::<span class="ident">default</span>();
|
||
<span class="ident">langtag_server</span>.<span class="ident">language</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="string">"de"</span>.<span class="ident">to_owned</span>());
|
||
<span class="ident">langtag_server</span>.<span class="ident">region</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="string">"AT"</span>.<span class="ident">to_owned</span>());
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">langtag_user</span>: <span class="ident">LanguageTag</span> <span class="op">=</span> <span class="ident">Default</span>::<span class="ident">default</span>();
|
||
<span class="ident">langtag_user</span>.<span class="ident">language</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="string">"de"</span>.<span class="ident">to_owned</span>());
|
||
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">langtag_user</span>.<span class="ident">matches</span>(<span class="kw-2">&</span><span class="ident">langtag_server</span>));</pre>
|
||
<p>There is also the <code>langtag!</code> macro for creating language tags.</p>
|
||
</div><h2 id='macros' class='section-header'><a href="#macros">Macros</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="macro" href="macro.langtag.html"
|
||
title='macro language_tags::langtag'>langtag</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Utility for creating simple language tags.</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.LanguageTag.html"
|
||
title='struct language_tags::LanguageTag'>LanguageTag</a></td>
|
||
<td class='docblock-short'>
|
||
<p>A language tag as described in <a href="http://tools.ietf.org/html/bcp47">BCP47</a>.</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.Error.html"
|
||
title='enum language_tags::Error'>Error</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Defines an Error type for langtags.</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.GRANDFATHERED.html"
|
||
title='constant language_tags::GRANDFATHERED'>GRANDFATHERED</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Contains all grandfathered tags.</p>
|
||
|
||
</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.Result.html"
|
||
title='type language_tags::Result'>Result</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Result type used for this library.</p>
|
||
|
||
</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><kbd>?</kbd></dt>
|
||
<dd>Show this help dialog</dd>
|
||
<dt><kbd>S</kbd></dt>
|
||
<dd>Focus the search field</dd>
|
||
<dt><kbd>↑</kbd></dt>
|
||
<dd>Move up in search results</dd>
|
||
<dt><kbd>↓</kbd></dt>
|
||
<dd>Move down in search results</dd>
|
||
<dt><kbd>↹</kbd></dt>
|
||
<dd>Switch tab</dd>
|
||
<dt><kbd>⏎</kbd></dt>
|
||
<dd>Go to active search result</dd>
|
||
<dt><kbd>+</kbd></dt>
|
||
<dd>Expand all sections</dd>
|
||
<dt><kbd>-</kbd></dt>
|
||
<dd>Collapse 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 = "language_tags";
|
||
</script>
|
||
<script src="../main.js"></script>
|
||
<script defer src="../search-index.js"></script>
|
||
</body>
|
||
</html> |