Files
rust-gpu/api/unicode_width/trait.UnicodeWidthStr.html
github-merge-queue[bot] 786e3b08a1 Deploying to gh-pages from @ 097f243da1 ๐Ÿš€
2026-04-17 12:31:51 +00:00

16 lines
7.4 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="Methods for determining displayed width of Unicode strings."><title>UnicodeWidthStr in unicode_width - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-17e0aaed.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.96.0-nightly (02c7f9bec 2026-04-10)" data-channel="nightly" data-search-js="search-b5634cc7.js" data-stringdex-js="stringdex-2da4960a.js" data-settings-js="settings-170eb4bf.js" ><script src="../static.files/storage-41dd4d93.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-5013f961.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-f7c3ffd8.css"></noscript><link rel="icon" href="https://unicode-rs.github.io/unicode-rs_sm.png"></head><body class="rustdoc trait"><a class="skip-main-content" href="#main-content">Skip to main content</a><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">UnicodeWidthStr</a></h2></rustdoc-topbar><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_<wbr>width</a><span class="version">0.2.2</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Unicode<wbr>Width<wbr>Str</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.width" title="width">width</a></li><li><a href="#tymethod.width_cjk" title="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-UnicodeWidthStr-for-str" title="str">str</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate unicode_<wbr>width</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content" tabindex="-1"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="index.html">unicode_width</a></div><h1>Trait <span class="trait">Unicode<wbr>Width<wbr>Str</span>&nbsp;<button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/unicode_width/lib.rs.html#229-246">Source</a> </span></div><pre class="rust item-decl"><code>pub trait UnicodeWidthStr: Sealed {
// Required methods
fn <a href="#tymethod.width" class="fn">width</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.usize.html">usize</a>;
<span class="item-spacer"></span> fn <a href="#tymethod.width_cjk" class="fn">width_cjk</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.usize.html">usize</a>;
}</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 strings.</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#236">Source</a><h4 class="code-header">fn <a href="#tymethod.width" class="fn">width</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>Returns the stringโ€™s displayed width in columns.</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#245">Source</a><h4 class="code-header">fn <a href="#tymethod.width_cjk" class="fn">width_cjk</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>Returns the stringโ€™s displayed width in columns.</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 column 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-UnicodeWidthStr-for-str" class="impl"><a class="src rightside" href="../src/unicode_width/lib.rs.html#248-259">Source</a><a href="#impl-UnicodeWidthStr-for-str" class="anchor">ยง</a><h3 class="code-header">impl <a class="trait" href="trait.UnicodeWidthStr.html" title="trait unicode_width::UnicodeWidthStr">UnicodeWidthStr</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.str.html">str</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#250-252">Source</a><a href="#method.width" class="anchor">ยง</a><h4 class="code-header">fn <a href="#tymethod.width" class="fn">width</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.usize.html">usize</a></h4></section><section id="method.width_cjk" class="method trait-impl"><a class="src rightside" href="../src/unicode_width/lib.rs.html#256-258">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>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.usize.html">usize</a></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.UnicodeWidthStr.js" data-ignore-extern-crates="core" async></script></section></div></main></body></html>