| <!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="Determine displayed width of `char` and `str` types according to Unicode Standard Annex #11 rules."><meta name="keywords" content="rust, rustlang, rust-lang, unicode_width"><title>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="../crates.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 mod crate"><!--[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="#">Crate unicode_width</a></h2><div class="sidebar-elems"><ul class="block"><li class="version">Version 0.1.10</li><li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#constants">Constants</a></li><li><a href="#traits">Traits</a></li></ul></section></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">Crate <a class="mod" href="#">unicode_width</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#11-131">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Determine displayed width of <code>char</code> and <code>str</code> types according to |
| <a href="http://www.unicode.org/reports/tr11/">Unicode Standard Annex #11</a> |
| rules.</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">extern crate </span>unicode_width; |
| |
| <span class="kw">use </span>unicode_width::UnicodeWidthStr; |
| |
| <span class="kw">fn </span>main() { |
| <span class="kw">let </span>teststr = <span class="string">"Ｈｅｌｌｏ, ｗｏｒｌｄ!"</span>; |
| <span class="kw">let </span>width = UnicodeWidthStr::width(teststr); |
| <span class="macro">println!</span>(<span class="string">"{}"</span>, teststr); |
| <span class="macro">println!</span>(<span class="string">"The above string is {} columns wide."</span>, width); |
| <span class="kw">let </span>width = teststr.width_cjk(); |
| <span class="macro">println!</span>(<span class="string">"The above string is {} columns wide (CJK)."</span>, width); |
| }</code></pre></div> |
| <h2 id="features"><a href="#features">features</a></h2> |
| <p>unicode-width supports a <code>no_std</code> feature. This eliminates dependence |
| on std, and instead uses equivalent functions from core.</p> |
| <h2 id="cratesio"><a href="#cratesio">crates.io</a></h2> |
| <p>You can use this package in your project by adding the following |
| to your <code>Cargo.toml</code>:</p> |
| <div class="example-wrap"><pre class="language-toml"><code>[dependencies] |
| unicode-width = "0.1.5"</code></pre></div></div></details><h2 id="constants" class="small-section-header"><a href="#constants">Constants</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.UNICODE_VERSION.html" title="unicode_width::UNICODE_VERSION constant">UNICODE_VERSION</a></div><div class="item-right docblock-short">The version of <a href="http://www.unicode.org/">Unicode</a> |
| that this version of unicode-width is based on.</div></div></div><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.UnicodeWidthChar.html" title="unicode_width::UnicodeWidthChar trait">UnicodeWidthChar</a></div><div class="item-right docblock-short">Methods for determining displayed width of Unicode characters.</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.UnicodeWidthStr.html" title="unicode_width::UnicodeWidthStr trait">UnicodeWidthStr</a></div><div class="item-right docblock-short">Methods for determining displayed width of Unicode strings.</div></div></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> |
