35 lines
6.5 KiB
HTML
35 lines
6.5 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 `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="../light.css" id="themeStyle"><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><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">☰</div><a href='../unicase/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Crate unicase</p><div class="sidebar-elems"><a id='all-types' href='all.html'><p>See all unicase's items</p></a><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"><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><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='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/unicase/lib.rs.html#1-465' title='goto source code'>[src]</a></span><span class='in-band'>Crate <a class="mod" href=''>unicase</a></span></h1><div class='docblock'><h1 id="unicase" class="section-header"><a href="#unicase">UniCase</a></h1>
|
||
<p>UniCase provides 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>
|
||
<div class="example-wrap"><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">"Maße"</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">"MASSE"</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">"mase"</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="op">=</span> <span class="ident">c</span>);</pre></div>
|
||
<h2 id="ascii" class="section-header"><a href="#ascii">Ascii</a></h2>
|
||
<div class="example-wrap"><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">"foobar"</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">"FoObAr"</span>);
|
||
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">a</span>, <span class="ident">b</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.Ascii.html" title='unicase::Ascii struct'>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='unicase::UniCase struct'>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='unicase::eq fn'>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='unicase::eq_ascii fn'>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><script>window.rootPath = "../";window.currentCrate = "unicase";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |