| <!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="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/unicode-width-0.1.10/src/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.rs - source</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="../../source-script.js"></script><script defer src="../../source-files.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 source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><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></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../unicode_width/index.html"> |
| <img src="https://unicode-rs.github.io/unicode-rs_sm.png" alt="logo"></a><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="example-wrap"><pre class="src-line-numbers"><span id="1">1</span> |
| <span id="2">2</span> |
| <span id="3">3</span> |
| <span id="4">4</span> |
| <span id="5">5</span> |
| <span id="6">6</span> |
| <span id="7">7</span> |
| <span id="8">8</span> |
| <span id="9">9</span> |
| <span id="10">10</span> |
| <span id="11">11</span> |
| <span id="12">12</span> |
| <span id="13">13</span> |
| <span id="14">14</span> |
| <span id="15">15</span> |
| <span id="16">16</span> |
| <span id="17">17</span> |
| <span id="18">18</span> |
| <span id="19">19</span> |
| <span id="20">20</span> |
| <span id="21">21</span> |
| <span id="22">22</span> |
| <span id="23">23</span> |
| <span id="24">24</span> |
| <span id="25">25</span> |
| <span id="26">26</span> |
| <span id="27">27</span> |
| <span id="28">28</span> |
| <span id="29">29</span> |
| <span id="30">30</span> |
| <span id="31">31</span> |
| <span id="32">32</span> |
| <span id="33">33</span> |
| <span id="34">34</span> |
| <span id="35">35</span> |
| <span id="36">36</span> |
| <span id="37">37</span> |
| <span id="38">38</span> |
| <span id="39">39</span> |
| <span id="40">40</span> |
| <span id="41">41</span> |
| <span id="42">42</span> |
| <span id="43">43</span> |
| <span id="44">44</span> |
| <span id="45">45</span> |
| <span id="46">46</span> |
| <span id="47">47</span> |
| <span id="48">48</span> |
| <span id="49">49</span> |
| <span id="50">50</span> |
| <span id="51">51</span> |
| <span id="52">52</span> |
| <span id="53">53</span> |
| <span id="54">54</span> |
| <span id="55">55</span> |
| <span id="56">56</span> |
| <span id="57">57</span> |
| <span id="58">58</span> |
| <span id="59">59</span> |
| <span id="60">60</span> |
| <span id="61">61</span> |
| <span id="62">62</span> |
| <span id="63">63</span> |
| <span id="64">64</span> |
| <span id="65">65</span> |
| <span id="66">66</span> |
| <span id="67">67</span> |
| <span id="68">68</span> |
| <span id="69">69</span> |
| <span id="70">70</span> |
| <span id="71">71</span> |
| <span id="72">72</span> |
| <span id="73">73</span> |
| <span id="74">74</span> |
| <span id="75">75</span> |
| <span id="76">76</span> |
| <span id="77">77</span> |
| <span id="78">78</span> |
| <span id="79">79</span> |
| <span id="80">80</span> |
| <span id="81">81</span> |
| <span id="82">82</span> |
| <span id="83">83</span> |
| <span id="84">84</span> |
| <span id="85">85</span> |
| <span id="86">86</span> |
| <span id="87">87</span> |
| <span id="88">88</span> |
| <span id="89">89</span> |
| <span id="90">90</span> |
| <span id="91">91</span> |
| <span id="92">92</span> |
| <span id="93">93</span> |
| <span id="94">94</span> |
| <span id="95">95</span> |
| <span id="96">96</span> |
| <span id="97">97</span> |
| <span id="98">98</span> |
| <span id="99">99</span> |
| <span id="100">100</span> |
| <span id="101">101</span> |
| <span id="102">102</span> |
| <span id="103">103</span> |
| <span id="104">104</span> |
| <span id="105">105</span> |
| <span id="106">106</span> |
| <span id="107">107</span> |
| <span id="108">108</span> |
| <span id="109">109</span> |
| <span id="110">110</span> |
| <span id="111">111</span> |
| <span id="112">112</span> |
| <span id="113">113</span> |
| <span id="114">114</span> |
| <span id="115">115</span> |
| <span id="116">116</span> |
| <span id="117">117</span> |
| <span id="118">118</span> |
| <span id="119">119</span> |
| <span id="120">120</span> |
| <span id="121">121</span> |
| <span id="122">122</span> |
| <span id="123">123</span> |
| <span id="124">124</span> |
| <span id="125">125</span> |
| <span id="126">126</span> |
| <span id="127">127</span> |
| <span id="128">128</span> |
| <span id="129">129</span> |
| <span id="130">130</span> |
| <span id="131">131</span> |
| </pre><pre class="rust"><code><span class="comment">// Copyright 2012-2015 The Rust Project Developers. See the COPYRIGHT |
| // file at the top-level directory of this distribution and at |
| // http://rust-lang.org/COPYRIGHT. |
| // |
| // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or |
| // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license |
| // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your |
| // option. This file may not be copied, modified, or distributed |
| // except according to those terms. |
| |
| </span><span class="doccomment">//! Determine displayed width of `char` and `str` types according to |
| //! [Unicode Standard Annex #11](http://www.unicode.org/reports/tr11/) |
| //! rules. |
| //! |
| //! ```rust |
| //! extern crate unicode_width; |
| //! |
| //! use unicode_width::UnicodeWidthStr; |
| //! |
| //! fn main() { |
| //! let teststr = "Ｈｅｌｌｏ, ｗｏｒｌｄ!"; |
| //! let width = UnicodeWidthStr::width(teststr); |
| //! println!("{}", teststr); |
| //! println!("The above string is {} columns wide.", width); |
| //! let width = teststr.width_cjk(); |
| //! println!("The above string is {} columns wide (CJK).", width); |
| //! } |
| //! ``` |
| //! |
| //! # features |
| //! |
| //! unicode-width supports a `no_std` feature. This eliminates dependence |
| //! on std, and instead uses equivalent functions from core. |
| //! |
| //! # crates.io |
| //! |
| //! You can use this package in your project by adding the following |
| //! to your `Cargo.toml`: |
| //! |
| //! ```toml |
| //! [dependencies] |
| //! unicode-width = "0.1.5" |
| //! ``` |
| |
| </span><span class="attribute">#![deny(missing_docs, unsafe_code)] |
| #![doc(html_logo_url = <span class="string">"https://unicode-rs.github.io/unicode-rs_sm.png"</span>, |
| html_favicon_url = <span class="string">"https://unicode-rs.github.io/unicode-rs_sm.png"</span>)] |
| |
| #![cfg_attr(feature = <span class="string">"bench"</span>, feature(test))] |
| #![no_std] |
| |
| #[cfg(test)] |
| #[macro_use] |
| </span><span class="kw">extern crate </span>std; |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"bench"</span>)] |
| </span><span class="kw">extern crate </span>test; |
| |
| <span class="kw">use </span>tables::charwidth <span class="kw">as </span>cw; |
| <span class="kw">pub use </span>tables::UNICODE_VERSION; |
| |
| <span class="kw">use </span>core::ops::Add; |
| |
| <span class="kw">mod </span>tables; |
| |
| <span class="attribute">#[cfg(test)] |
| </span><span class="kw">mod </span>tests; |
| |
| <span class="doccomment">/// Methods for determining displayed width of Unicode characters. |
| </span><span class="kw">pub trait </span>UnicodeWidthChar { |
| <span class="doccomment">/// Returns the character's displayed width in columns, or `None` if the |
| /// character is a control character other than `'\x00'`. |
| /// |
| /// This function treats characters in the Ambiguous category according |
| /// to [Unicode Standard Annex #11](http://www.unicode.org/reports/tr11/) |
| /// as 1 column wide. This is consistent with the recommendations for non-CJK |
| /// contexts, or when the context cannot be reliably determined. |
| </span><span class="kw">fn </span>width(<span class="self">self</span>) -> <span class="prelude-ty">Option</span><usize>; |
| |
| <span class="doccomment">/// Returns the character's displayed width in columns, or `None` if the |
| /// character is a control character other than `'\x00'`. |
| /// |
| /// This function treats characters in the Ambiguous category according |
| /// to [Unicode Standard Annex #11](http://www.unicode.org/reports/tr11/) |
| /// as 2 columns wide. This is consistent with the recommendations for |
| /// CJK contexts. |
| </span><span class="kw">fn </span>width_cjk(<span class="self">self</span>) -> <span class="prelude-ty">Option</span><usize>; |
| } |
| |
| <span class="kw">impl </span>UnicodeWidthChar <span class="kw">for </span>char { |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>width(<span class="self">self</span>) -> <span class="prelude-ty">Option</span><usize> { cw::width(<span class="self">self</span>, <span class="bool-val">false</span>) } |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>width_cjk(<span class="self">self</span>) -> <span class="prelude-ty">Option</span><usize> { cw::width(<span class="self">self</span>, <span class="bool-val">true</span>) } |
| } |
| |
| <span class="doccomment">/// Methods for determining displayed width of Unicode strings. |
| </span><span class="kw">pub trait </span>UnicodeWidthStr { |
| <span class="doccomment">/// Returns the string's displayed width in columns. |
| /// |
| /// Control characters are treated as having zero width. |
| /// |
| /// This function treats characters in the Ambiguous category according |
| /// to [Unicode Standard Annex #11](http://www.unicode.org/reports/tr11/) |
| /// as 1 column wide. This is consistent with the recommendations for |
| /// non-CJK contexts, or when the context cannot be reliably determined. |
| </span><span class="kw">fn </span>width<<span class="lifetime">'a</span>>(<span class="kw-2">&</span><span class="lifetime">'a </span><span class="self">self</span>) -> usize; |
| |
| <span class="doccomment">/// Returns the string's displayed width in columns. |
| /// |
| /// Control characters are treated as having zero width. |
| /// |
| /// This function treats characters in the Ambiguous category according |
| /// to [Unicode Standard Annex #11](http://www.unicode.org/reports/tr11/) |
| /// as 2 column wide. This is consistent with the recommendations for |
| /// CJK contexts. |
| </span><span class="kw">fn </span>width_cjk<<span class="lifetime">'a</span>>(<span class="kw-2">&</span><span class="lifetime">'a </span><span class="self">self</span>) -> usize; |
| } |
| |
| <span class="kw">impl </span>UnicodeWidthStr <span class="kw">for </span>str { |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>width(<span class="kw-2">&</span><span class="self">self</span>) -> usize { |
| <span class="self">self</span>.chars().map(|c| cw::width(c, <span class="bool-val">false</span>).unwrap_or(<span class="number">0</span>)).fold(<span class="number">0</span>, Add::add) |
| } |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>width_cjk(<span class="kw-2">&</span><span class="self">self</span>) -> usize { |
| <span class="self">self</span>.chars().map(|c| cw::width(c, <span class="bool-val">true</span>).unwrap_or(<span class="number">0</span>)).fold(<span class="number">0</span>, Add::add) |
| } |
| } |
| </code></pre></div> |
| </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> |
