mentat/unicase/index.html
2018-08-22 17:04:13 +00:00

189 lines
No EOL
8.8 KiB
HTML
Raw 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 `unicase` crate.">
<meta name="keywords" content="rust, rustlang, rust-lang, unicase">
<title>unicase - 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">&#9776;</div>
<p class='location'>Crate unicase</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'unicase', 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=''>unicase</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/unicase/lib.rs.html#1-360' title='goto source code'>[src]</a></span></h1>
<div class='docblock'><h1 id="unicase" class="section-header"><a href="#unicase">UniCase</a></h1>
<p>UniCase provices a way of specifying strings that are case-insensitive.</p>
<p>UniCase supports full <a href="https://www.w3.org/International/wiki/Case_folding">Unicode case
folding</a>. It can also
utilize faster ASCII case comparisons, if both strings are ASCII.</p>
<p>Using the <code>UniCase::new()</code> constructor will check the string to see if it
is all ASCII. When a <code>UniCase</code> is compared against another, if both are
ASCII, it will use the faster comparison.</p>
<p>There also exists the <code>Ascii</code> type in this crate, which will always assume
to use the ASCII case comparisons, if the encoding is already known.</p>
<h2 id="example" class="section-header"><a href="#example">Example</a></h2>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">unicase</span>::<span class="ident">UniCase</span>;
<span class="kw">let</span> <span class="ident">a</span> <span class="op">=</span> <span class="ident">UniCase</span>::<span class="ident">new</span>(<span class="string">&quot;Maße&quot;</span>);
<span class="kw">let</span> <span class="ident">b</span> <span class="op">=</span> <span class="ident">UniCase</span>::<span class="ident">new</span>(<span class="string">&quot;MASSE&quot;</span>);
<span class="kw">let</span> <span class="ident">c</span> <span class="op">=</span> <span class="ident">UniCase</span>::<span class="ident">new</span>(<span class="string">&quot;mase&quot;</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">a</span>, <span class="ident">b</span>);
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">b</span> <span class="op">!=</span> <span class="ident">c</span>);</pre>
<h2 id="ascii" class="section-header"><a href="#ascii">Ascii</a></h2>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">unicase</span>::<span class="ident">Ascii</span>;
<span class="kw">let</span> <span class="ident">a</span> <span class="op">=</span> <span class="ident">Ascii</span>::<span class="ident">new</span>(<span class="string">&quot;foobar&quot;</span>);
<span class="kw">let</span> <span class="ident">b</span> <span class="op">=</span> <span class="ident">Ascii</span>::<span class="ident">new</span>(<span class="string">&quot;FoObAr&quot;</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">a</span>, <span class="ident">b</span>);</pre>
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table>
<tr class=' module-item'>
<td><a class="struct" href="struct.Ascii.html"
title='struct unicase::Ascii'>Ascii</a></td>
<td class='docblock-short'>
<p>Case Insensitive wrapper of Ascii strings.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.UniCase.html"
title='struct unicase::UniCase'>UniCase</a></td>
<td class='docblock-short'>
<p>Case Insensitive wrapper of strings.</p>
</td>
</tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
<table>
<tr class=' module-item'>
<td><a class="fn" href="fn.eq.html"
title='fn unicase::eq'>eq</a></td>
<td class='docblock-short'>
<p>Compare two string-like types for case-less equality, using unicode folding.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.eq_ascii.html"
title='fn unicase::eq_ascii'>eq_ascii</a></td>
<td class='docblock-short'>
<p>Compare two string-like types for case-less equality, ignoring ASCII case.</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>&#9166;</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 = "unicase";
</script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>