237 lines
No EOL
16 KiB
HTML
237 lines
No EOL
16 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 `AsciiExt` trait in crate `bitflags`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, AsciiExt">
|
||
|
||
<title>bitflags::__core::ascii::AsciiExt - 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'><a href='../../index.html'>bitflags</a>::<wbr><a href='../index.html'>__core</a>::<wbr><a href='index.html'>ascii</a></p><script>window.sidebarCurrent = {name: 'AsciiExt', ty: 'trait', relpath: ''};</script><script defer src="sidebar-items.js"></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 trait">
|
||
<h1 class='fqn'><span class='in-band'>Trait <a href='../../index.html'>bitflags</a>::<wbr><a href='../index.html'>__core</a>::<wbr><a href='index.html'>ascii</a>::<wbr><a class='trait' href=''>AsciiExt</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 id='src-648' class='srclink' href='https://doc.rust-lang.org/nightly/std/ascii/trait.AsciiExt.html?gotosrc=648' title='goto source code'>[src]</a></span></h1>
|
||
<pre class='rust trait'>pub trait AsciiExt {
|
||
type <a href='#associatedtype.Owned' class='type'>Owned</a>;
|
||
fn <a href='#tymethod.is_ascii' class='fnname'>is_ascii</a>(&self) -> <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.bool.html'>bool</a>;
|
||
fn <a href='#tymethod.to_ascii_uppercase' class='fnname'>to_ascii_uppercase</a>(&self) -> Self::<a class='trait' href='../../../bitflags/__core/ascii/trait.AsciiExt.html' title='bitflags::__core::ascii::AsciiExt'>Owned</a>;
|
||
fn <a href='#tymethod.to_ascii_lowercase' class='fnname'>to_ascii_lowercase</a>(&self) -> Self::<a class='trait' href='../../../bitflags/__core/ascii/trait.AsciiExt.html' title='bitflags::__core::ascii::AsciiExt'>Owned</a>;
|
||
fn <a href='#tymethod.eq_ignore_ascii_case' class='fnname'>eq_ignore_ascii_case</a>(&self, other: &Self) -> <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.bool.html'>bool</a>;
|
||
fn <a href='#tymethod.make_ascii_uppercase' class='fnname'>make_ascii_uppercase</a>(&mut self);
|
||
fn <a href='#tymethod.make_ascii_lowercase' class='fnname'>make_ascii_lowercase</a>(&mut self);
|
||
}</pre><div class='docblock'><p>Extension methods for ASCII-subset only operations on string slices.</p>
|
||
|
||
<p>Be aware that operations on seemingly non-ASCII characters can sometimes
|
||
have unexpected results. Consider this example:</p>
|
||
|
||
<pre class='rust rust-example-rendered'>
|
||
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>ascii</span>::<span class='ident'>AsciiExt</span>;
|
||
|
||
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='string'>"café"</span>.<span class='ident'>to_ascii_uppercase</span>(), <span class='string'>"CAFÉ"</span>);
|
||
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='string'>"café"</span>.<span class='ident'>to_ascii_uppercase</span>(), <span class='string'>"CAFé"</span>);</pre>
|
||
|
||
<p>In the first example, the lowercased string is represented <code>"cafe\u{301}"</code>
|
||
(the last character is an acute accent <a href="https://en.wikipedia.org/wiki/Combining_character">combining character</a>). Unlike the
|
||
other characters in the string, the combining character will not get mapped
|
||
to an uppercase variant, resulting in <code>"CAFE\u{301}"</code>. In the second
|
||
example, the lowercased string is represented <code>"caf\u{e9}"</code> (the last
|
||
character is a single Unicode character representing an 'e' with an acute
|
||
accent). Since the last character is defined outside the scope of ASCII,
|
||
it will not get mapped to an uppercase variant, resulting in <code>"CAF\u{e9}"</code>.</p>
|
||
</div>
|
||
<h2 id='associated-types'>Associated Types</h2>
|
||
<div class='methods'>
|
||
<h3 id='associatedtype.Owned' class='method stab '><code>type <a href='#associatedtype.Owned' class='type'>Owned</a></code></h3><div class='docblock'><p>Container type for copied ASCII characters.</p>
|
||
</div></div>
|
||
<h2 id='required-methods'>Required Methods</h2>
|
||
<div class='methods'>
|
||
<h3 id='tymethod.is_ascii' class='method stab '><code>fn <a href='#tymethod.is_ascii' class='fnname'>is_ascii</a>(&self) -> <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.bool.html'>bool</a></code></h3><div class='docblock'><p>Checks if the value is within the ASCII range.</p>
|
||
|
||
<h1 id='examples' class='section-header'><a href='#examples'>Examples</a></h1>
|
||
<pre class='rust rust-example-rendered'>
|
||
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>ascii</span>::<span class='ident'>AsciiExt</span>;
|
||
|
||
<span class='kw'>let</span> <span class='ident'>ascii</span> <span class='op'>=</span> <span class='string'>'a'</span>;
|
||
<span class='kw'>let</span> <span class='ident'>utf8</span> <span class='op'>=</span> <span class='string'>'❤'</span>;
|
||
|
||
<span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>ascii</span>.<span class='ident'>is_ascii</span>());
|
||
<span class='macro'>assert</span><span class='macro'>!</span>(<span class='op'>!</span><span class='ident'>utf8</span>.<span class='ident'>is_ascii</span>());</pre>
|
||
</div><h3 id='tymethod.to_ascii_uppercase' class='method stab '><code>fn <a href='#tymethod.to_ascii_uppercase' class='fnname'>to_ascii_uppercase</a>(&self) -> Self::<a class='trait' href='../../../bitflags/__core/ascii/trait.AsciiExt.html' title='bitflags::__core::ascii::AsciiExt'>Owned</a></code></h3><div class='docblock'><p>Makes a copy of the string in ASCII upper case.</p>
|
||
|
||
<p>ASCII letters 'a' to 'z' are mapped to 'A' to 'Z',
|
||
but non-ASCII letters are unchanged.</p>
|
||
|
||
<h1 id='examples-1' class='section-header'><a href='#examples-1'>Examples</a></h1>
|
||
<pre class='rust rust-example-rendered'>
|
||
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>ascii</span>::<span class='ident'>AsciiExt</span>;
|
||
|
||
<span class='kw'>let</span> <span class='ident'>ascii</span> <span class='op'>=</span> <span class='string'>'a'</span>;
|
||
<span class='kw'>let</span> <span class='ident'>utf8</span> <span class='op'>=</span> <span class='string'>'❤'</span>;
|
||
|
||
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='string'>'A'</span>, <span class='ident'>ascii</span>.<span class='ident'>to_ascii_uppercase</span>());
|
||
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='string'>'❤'</span>, <span class='ident'>utf8</span>.<span class='ident'>to_ascii_uppercase</span>());</pre>
|
||
</div><h3 id='tymethod.to_ascii_lowercase' class='method stab '><code>fn <a href='#tymethod.to_ascii_lowercase' class='fnname'>to_ascii_lowercase</a>(&self) -> Self::<a class='trait' href='../../../bitflags/__core/ascii/trait.AsciiExt.html' title='bitflags::__core::ascii::AsciiExt'>Owned</a></code></h3><div class='docblock'><p>Makes a copy of the string in ASCII lower case.</p>
|
||
|
||
<p>ASCII letters 'A' to 'Z' are mapped to 'a' to 'z',
|
||
but non-ASCII letters are unchanged.</p>
|
||
|
||
<h1 id='examples-2' class='section-header'><a href='#examples-2'>Examples</a></h1>
|
||
<pre class='rust rust-example-rendered'>
|
||
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>ascii</span>::<span class='ident'>AsciiExt</span>;
|
||
|
||
<span class='kw'>let</span> <span class='ident'>ascii</span> <span class='op'>=</span> <span class='string'>'A'</span>;
|
||
<span class='kw'>let</span> <span class='ident'>utf8</span> <span class='op'>=</span> <span class='string'>'❤'</span>;
|
||
|
||
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='string'>'a'</span>, <span class='ident'>ascii</span>.<span class='ident'>to_ascii_lowercase</span>());
|
||
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='string'>'❤'</span>, <span class='ident'>utf8</span>.<span class='ident'>to_ascii_lowercase</span>());</pre>
|
||
</div><h3 id='tymethod.eq_ignore_ascii_case' class='method stab '><code>fn <a href='#tymethod.eq_ignore_ascii_case' class='fnname'>eq_ignore_ascii_case</a>(&self, other: &Self) -> <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.bool.html'>bool</a></code></h3><div class='docblock'><p>Checks that two strings are an ASCII case-insensitive match.</p>
|
||
|
||
<p>Same as <code>to_ascii_lowercase(a) == to_ascii_lowercase(b)</code>,
|
||
but without allocating and copying temporary strings.</p>
|
||
|
||
<h1 id='examples-3' class='section-header'><a href='#examples-3'>Examples</a></h1>
|
||
<pre class='rust rust-example-rendered'>
|
||
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>ascii</span>::<span class='ident'>AsciiExt</span>;
|
||
|
||
<span class='kw'>let</span> <span class='ident'>ascii1</span> <span class='op'>=</span> <span class='string'>'A'</span>;
|
||
<span class='kw'>let</span> <span class='ident'>ascii2</span> <span class='op'>=</span> <span class='string'>'a'</span>;
|
||
<span class='kw'>let</span> <span class='ident'>ascii3</span> <span class='op'>=</span> <span class='string'>'A'</span>;
|
||
<span class='kw'>let</span> <span class='ident'>ascii4</span> <span class='op'>=</span> <span class='string'>'z'</span>;
|
||
|
||
<span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>ascii1</span>.<span class='ident'>eq_ignore_ascii_case</span>(<span class='kw-2'>&</span><span class='ident'>ascii2</span>));
|
||
<span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>ascii1</span>.<span class='ident'>eq_ignore_ascii_case</span>(<span class='kw-2'>&</span><span class='ident'>ascii3</span>));
|
||
<span class='macro'>assert</span><span class='macro'>!</span>(<span class='op'>!</span><span class='ident'>ascii1</span>.<span class='ident'>eq_ignore_ascii_case</span>(<span class='kw-2'>&</span><span class='ident'>ascii4</span>));</pre>
|
||
</div><h3 id='tymethod.make_ascii_uppercase' class='method stab '><code>fn <a href='#tymethod.make_ascii_uppercase' class='fnname'>make_ascii_uppercase</a>(&mut self)</code><span class="since">1.9.0</span></h3><div class='docblock'><p>Converts this type to its ASCII upper case equivalent in-place.</p>
|
||
|
||
<p>See <code>to_ascii_uppercase</code> for more information.</p>
|
||
|
||
<h1 id='examples-4' class='section-header'><a href='#examples-4'>Examples</a></h1>
|
||
<pre class='rust rust-example-rendered'>
|
||
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>ascii</span>::<span class='ident'>AsciiExt</span>;
|
||
|
||
<span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>ascii</span> <span class='op'>=</span> <span class='string'>'a'</span>;
|
||
|
||
<span class='ident'>ascii</span>.<span class='ident'>make_ascii_uppercase</span>();
|
||
|
||
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='string'>'A'</span>, <span class='ident'>ascii</span>);</pre>
|
||
</div><h3 id='tymethod.make_ascii_lowercase' class='method stab '><code>fn <a href='#tymethod.make_ascii_lowercase' class='fnname'>make_ascii_lowercase</a>(&mut self)</code><span class="since">1.9.0</span></h3><div class='docblock'><p>Converts this type to its ASCII lower case equivalent in-place.</p>
|
||
|
||
<p>See <code>to_ascii_lowercase</code> for more information.</p>
|
||
|
||
<h1 id='examples-5' class='section-header'><a href='#examples-5'>Examples</a></h1>
|
||
<pre class='rust rust-example-rendered'>
|
||
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>ascii</span>::<span class='ident'>AsciiExt</span>;
|
||
|
||
<span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>ascii</span> <span class='op'>=</span> <span class='string'>'A'</span>;
|
||
|
||
<span class='ident'>ascii</span>.<span class='ident'>make_ascii_lowercase</span>();
|
||
|
||
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='string'>'a'</span>, <span class='ident'>ascii</span>);</pre>
|
||
</div></div>
|
||
<h2 id='implementors'>Implementors</h2>
|
||
<ul class='item-list' id='implementors-list'>
|
||
<li><code>impl AsciiExt for <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.char.html'>char</a></code></li>
|
||
<li><code>impl AsciiExt for <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.u8.html'>u8</a></code></li>
|
||
<li><code>impl AsciiExt for <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.slice.html'>[</a><a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.u8.html'>u8</a><a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.slice.html'>]</a></code></li>
|
||
<li><code>impl AsciiExt for <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.str.html'>str</a></code></li>
|
||
</ul><script type="text/javascript" async
|
||
src="../../../implementors/std/ascii/trait.AsciiExt.js">
|
||
</script></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>⇤</dt>
|
||
<dd>Move up in search results</dd>
|
||
<dt>⇥</dt>
|
||
<dd>Move down in search results</dd>
|
||
<dt>⏎</dt>
|
||
<dd>Go to active search result</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 = "bitflags";
|
||
window.playgroundUrl = "";
|
||
</script>
|
||
<script src="../../../jquery.js"></script>
|
||
<script src="../../../main.js"></script>
|
||
|
||
<script defer src="../../../search-index.js"></script>
|
||
</body>
|
||
</html> |