| <!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."><meta name="keywords" content="rust, rustlang, rust-lang, UnicodeWidthStr"><title>UnicodeWidthStr in unicode_width - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../normalize.css"><link rel="stylesheet" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../ayu.css" disabled><link rel="stylesheet" href="../dark.css" disabled><link rel="stylesheet" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.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">☰</button><a class="sidebar-logo" href="../unicode_width/index.html"><div class="logo-container"><img src="https://unicode-rs.github.io/unicode-rs_sm.png" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../unicode_width/index.html"><div class="logo-container"> |
| <img src="https://unicode-rs.github.io/unicode-rs_sm.png" alt="logo"></div></a><h2 class="location"><a href="#">UnicodeWidthStr</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-UnicodeWidthStr-for-str">str</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In unicode_width</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Trait <a href="index.html">unicode_width</a>::<wbr><a class="trait" href="#">UnicodeWidthStr</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../src/unicode_width/lib.rs.html#99-119">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="item-decl"><pre class="rust trait"><code>pub trait UnicodeWidthStr { |
| fn <a href="#tymethod.width" class="fnname">width</a><'a>(&'a self) -> <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="fnname">width_cjk</a><'a>(&'a self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.usize.html">usize</a>; |
| }</code></pre></div><details class="rustdoc-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="small-section-header">Required Methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.width" class="method has-srclink"><a class="srclink rightside" href="../src/unicode_width/lib.rs.html#108">source</a><h4 class="code-header">fn <a href="#tymethod.width" class="fnname">width</a><'a>(&'a self) -> <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>Control characters are treated as having zero width.</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="rustdoc-toggle method-toggle" open><summary><section id="tymethod.width_cjk" class="method has-srclink"><a class="srclink rightside" href="../src/unicode_width/lib.rs.html#118">source</a><h4 class="code-header">fn <a href="#tymethod.width_cjk" class="fnname">width_cjk</a><'a>(&'a self) -> <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>Control characters are treated as having zero width.</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="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor"></a></h2><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-UnicodeWidthStr-for-str" class="impl has-srclink"><a class="srclink rightside" href="../src/unicode_width/lib.rs.html#121-131">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 has-srclink"><a class="srclink rightside" href="../src/unicode_width/lib.rs.html#123-125">source</a><a href="#method.width" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.width" class="fnname">width</a>(&self) -> <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 has-srclink"><a class="srclink rightside" href="../src/unicode_width/lib.rs.html#128-130">source</a><a href="#method.width_cjk" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.width_cjk" class="fnname">width_cjk</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.usize.html">usize</a></h4></section></div></details><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div id="implementors-list"></div><script src="../implementors/unicode_width/trait.UnicodeWidthStr.js" data-ignore-extern-crates="core" async></script></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="unicode_width" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
