edlang/unicode_width/trait.UnicodeWidthChar.html
2024-02-13 06:38:44 +00:00

19 lines
9.2 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="Methods for determining displayed width of Unicode characters."><title>UnicodeWidthChar in unicode_width - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-ac92e1bbe349e143.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="unicode_width" data-themes="" data-resource-suffix="" data-rustdoc-version="1.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="icon" href="https://unicode-rs.github.io/unicode-rs_sm.png"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="logo-container" href="../unicode_width/index.html"><img src="https://unicode-rs.github.io/unicode-rs_sm.png" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../unicode_width/index.html"><img src="https://unicode-rs.github.io/unicode-rs_sm.png" alt="logo"></a><h2><a href="../unicode_width/index.html">unicode_width</a><span class="version">0.1.11</span></h2></div><h2 class="location"><a href="#">UnicodeWidthChar</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.width">width</a></li><li><a href="#tymethod.width_cjk">width_cjk</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-UnicodeWidthChar-for-char">char</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In crate unicode_width</a></h2></div></nav><div class="sidebar-resizer"></div>
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../unicode_width/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press S to search, ? for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Trait <a href="index.html">unicode_width</a>::<wbr><a class="trait" href="#">UnicodeWidthChar</a><button id="copy-path" title="Copy item path to clipboard"><img src="../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../src/unicode_width/lib.rs.html#68-86">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub trait UnicodeWidthChar {
// Required methods
fn <a href="#tymethod.width" class="fn">width</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>&gt;;
<span class="item-spacer"></span> fn <a href="#tymethod.width_cjk" class="fn">width_cjk</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>&gt;;
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Methods for determining displayed width of Unicode characters.</p>
</div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.width" class="method"><a class="src rightside" href="../src/unicode_width/lib.rs.html#76">source</a><h4 class="code-header">fn <a href="#tymethod.width" class="fn">width</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>&gt;</h4></section></summary><div class="docblock"><p>Returns the characters 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></details><details class="toggle method-toggle" open><summary><section id="tymethod.width_cjk" class="method"><a class="src rightside" href="../src/unicode_width/lib.rs.html#85">source</a><h4 class="code-header">fn <a href="#tymethod.width_cjk" class="fn">width_cjk</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>&gt;</h4></section></summary><div class="docblock"><p>Returns the characters 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></details></div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-UnicodeWidthChar-for-char" class="impl"><a class="src rightside" href="../src/unicode_width/lib.rs.html#88-94">source</a><a href="#impl-UnicodeWidthChar-for-char" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.UnicodeWidthChar.html" title="trait unicode_width::UnicodeWidthChar">UnicodeWidthChar</a> for <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.char.html">char</a></h3></section></summary><div class="impl-items"><section id="method.width" class="method trait-impl"><a class="src rightside" href="../src/unicode_width/lib.rs.html#90">source</a><a href="#method.width" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.width" class="fn">width</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>&gt;</h4></section><section id="method.width_cjk" class="method trait-impl"><a class="src rightside" href="../src/unicode_width/lib.rs.html#93">source</a><a href="#method.width_cjk" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.width_cjk" class="fn">width_cjk</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>&gt;</h4></section></div></details><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../trait.impl/unicode_width/trait.UnicodeWidthChar.js" data-ignore-extern-crates="core" async></script></section></div></main></body></html>