<!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="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="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings"></script><script src="../storage.js"></script><script src="../crates.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="https://unicode-rs.github.io/unicode-rs_sm.png"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></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="sidebar"><div class="sidebar-menu" role="button">☰</div><a 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">Trait UnicodeWidthStr</h2><div class="sidebar-elems"><div class="block items"><h3 class="sidebar-title"><a href="#required-methods">Required Methods</a></h3><div class="sidebar-links"><a href="#tymethod.width">width</a><a href="#tymethod.width_cjk">width_cjk</a></div><h3 class="sidebar-title"><a href="#implementors">Implementors</a></h3></div><h2 class="location">Other items in<br><a href="index.html">unicode_width</a></h2><div id="sidebar-vars" data-name="UnicodeWidthStr" data-ty="trait" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img src="../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../settings.html" title="settings"><img src="../wheel.svg" width="18" height="18" alt="Change settings"></a></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="#">UnicodeWidthStr</a><button id="copy-path" onclick="copy_path(this)" title="copy path"><img src="../clipboard.svg" width="19" height="18" alt="Copy item import" title="Copy item import to clipboard"></button></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 class="srclink" href="../src/unicode_width/lib.rs.html#99-119" title="goto source code">[src]</a></span></h1><div class="docblock type-decl"><pre class="rust trait">pub trait UnicodeWidthStr {
fn <a href="#tymethod.width" class="fnname">width</a><'a>(&'a self) -> usize;
<div class="item-spacer"></div> fn <a href="#tymethod.width_cjk" class="fnname">width_cjk</a><'a>(&'a self) -> usize;
}</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" open><summary><div id="tymethod.width" class="method has-srclink"><h4 class="code-header">fn <a href="#tymethod.width" class="fnname">width</a><'a>(&'a self) -> usize</h4><a class="srclink" href="../src/unicode_width/lib.rs.html#108" title="goto source code">[src]</a></div></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" open><summary><div id="tymethod.width_cjk" class="method has-srclink"><h4 class="code-header">fn <a href="#tymethod.width_cjk" class="fnname">width_cjk</a><'a>(&'a self) -> usize</h4><a class="srclink" href="../src/unicode_width/lib.rs.html#118" title="goto source code">[src]</a></div></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="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"><details class="rustdoc-toggle implementors-toggle"><summary><div id="impl-UnicodeWidthStr" class="impl has-srclink"><h3 class="code-header in-band">impl <a class="trait" href="trait.UnicodeWidthStr.html" title="trait unicode_width::UnicodeWidthStr">UnicodeWidthStr</a> for str</h3><a href="#impl-UnicodeWidthStr" class="anchor"></a><a class="srclink" href="../src/unicode_width/lib.rs.html#121-131" title="goto source code">[src]</a></div></summary><div class="impl-items"><div id="method.width" class="method trait-impl has-srclink"><h4 class="code-header">fn <a href="#tymethod.width" class="fnname">width</a>(&self) -> usize</h4><a href="#method.width" class="anchor"></a><a class="srclink" href="../src/unicode_width/lib.rs.html#123-125" title="goto source code">[src]</a></div><div id="method.width_cjk" class="method trait-impl has-srclink"><h4 class="code-header">fn <a href="#tymethod.width_cjk" class="fnname">width_cjk</a>(&self) -> usize</h4><a href="#method.width_cjk" class="anchor"></a><a class="srclink" href="../src/unicode_width/lib.rs.html#128-130" title="goto source code">[src]</a></div></div></details></div><script type="text/javascript" src="../implementors/unicode_width/trait.UnicodeWidthStr.js" async></script></section><section id="search" class="content hidden"></section><div id="rustdoc-vars" data-root-path="../" data-current-crate="unicode_width" data-search-index-js="../search-index.js" data-search-js="../search.js"></div><script src="../main.js"></script></body></html>