mentat/unicode_width/trait.UnicodeWidthChar.html
2018-08-22 17:04:13 +00:00

156 lines
No EOL
7.9 KiB
HTML
Raw Permalink 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 `UnicodeWidthChar` trait in crate `unicode_width`.">
<meta name="keywords" content="rust, rustlang, rust-lang, UnicodeWidthChar">
<title>unicode_width::UnicodeWidthChar - 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>
<link rel="shortcut icon" href="https://unicode-rs.github.io/unicode-rs_sm.png">
</head>
<body class="rustdoc trait">
<!--[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>
<a href='../unicode_width/index.html'><img src='https://unicode-rs.github.io/unicode-rs_sm.png' alt='logo' width='100'></a>
<p class='location'>Trait UnicodeWidthChar</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.width">width</a><a href="#tymethod.width_cjk">width_cjk</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='index.html'>unicode_width</a></p><script>window.sidebarCurrent = {name: 'UnicodeWidthChar', ty: 'trait', relpath: ''};</script><script defer src="sidebar-items.js"></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'>Trait <a href='index.html'>unicode_width</a>::<wbr><a class="trait" href=''>UnicodeWidthChar</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/unicode_width/lib.rs.html#70-88' title='goto source code'>[src]</a></span></h1>
<pre class='rust trait'>pub trait UnicodeWidthChar {
fn <a href='#tymethod.width' class='fnname'>width</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;usize&gt;;
<div class='item-spacer'></div> fn <a href='#tymethod.width_cjk' class='fnname'>width_cjk</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;usize&gt;;
}</pre><div class='docblock'><p>Methods for determining displayed width of Unicode characters.</p>
</div>
<h2 id='required-methods' class='small-section-header'>
Required Methods<a href='#required-methods' class='anchor'></a>
</h2>
<div class='methods'>
<h3 id='tymethod.width' class='method'><span id='width.v' class='invisible'><code>fn <a href='#tymethod.width' class='fnname'>width</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;usize&gt;</code></span></h3><div class='docblock'><p>Returns the character's displayed width in columns, or <code>None</code> if the
character is a control character other than <code>'\x00'</code>.</p>
<p>This function treats characters in the Ambiguous category according
to <a href="http://www.unicode.org/reports/tr11/">Unicode Standard Annex #11</a>
as 1 column wide. This is consistent with the recommendations for non-CJK
contexts, or when the context cannot be reliably determined.</p>
</div><h3 id='tymethod.width_cjk' class='method'><span id='width_cjk.v' class='invisible'><code>fn <a href='#tymethod.width_cjk' class='fnname'>width_cjk</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;usize&gt;</code></span></h3><div class='docblock'><p>Returns the character's displayed width in columns, or <code>None</code> if the
character is a control character other than <code>'\x00'</code>.</p>
<p>This function treats characters in the Ambiguous category according
to <a href="http://www.unicode.org/reports/tr11/">Unicode Standard Annex #11</a>
as 2 columns wide. This is consistent with the recommendations for
CJK contexts.</p>
</div></div>
<h2 id='implementors' class='small-section-header'>
Implementors<a href='#implementors' class='anchor'></a>
</h2>
<ul class='item-list' id='implementors-list'>
<li><div class='out-of-band'><a class='srclink' href='../src/unicode_width/lib.rs.html#90-96' title='goto source code'>[src]</a></div><code>impl UnicodeWidthChar for char</code></li>
</ul><script type="text/javascript" async
src="../implementors/unicode_width/trait.UnicodeWidthChar.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><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 = "unicode_width";
</script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>