| <!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/heck-0.3.3/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="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></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="../../heck/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../heck/index.html"><img class="rust-logo" src="../../rust-logo.svg" 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> |
| <span id="132">132</span> |
| <span id="133">133</span> |
| <span id="134">134</span> |
| <span id="135">135</span> |
| <span id="136">136</span> |
| <span id="137">137</span> |
| <span id="138">138</span> |
| <span id="139">139</span> |
| <span id="140">140</span> |
| <span id="141">141</span> |
| <span id="142">142</span> |
| <span id="143">143</span> |
| <span id="144">144</span> |
| <span id="145">145</span> |
| <span id="146">146</span> |
| <span id="147">147</span> |
| <span id="148">148</span> |
| <span id="149">149</span> |
| <span id="150">150</span> |
| <span id="151">151</span> |
| <span id="152">152</span> |
| <span id="153">153</span> |
| <span id="154">154</span> |
| <span id="155">155</span> |
| <span id="156">156</span> |
| <span id="157">157</span> |
| <span id="158">158</span> |
| <span id="159">159</span> |
| <span id="160">160</span> |
| <span id="161">161</span> |
| <span id="162">162</span> |
| <span id="163">163</span> |
| <span id="164">164</span> |
| <span id="165">165</span> |
| <span id="166">166</span> |
| <span id="167">167</span> |
| <span id="168">168</span> |
| <span id="169">169</span> |
| <span id="170">170</span> |
| <span id="171">171</span> |
| <span id="172">172</span> |
| <span id="173">173</span> |
| <span id="174">174</span> |
| <span id="175">175</span> |
| <span id="176">176</span> |
| <span id="177">177</span> |
| <span id="178">178</span> |
| <span id="179">179</span> |
| <span id="180">180</span> |
| <span id="181">181</span> |
| </pre><pre class="rust"><code><span class="doccomment">//! **heck** is a case conversion library. |
| //! |
| //! This library exists to provide case conversion between common cases like |
| //! CamelCase and snake_case. It is intended to be unicode aware, internally, |
| //! consistent, and reasonably well performing. |
| //! |
| //! ## Definition of a word boundary |
| //! |
| //! Word boundaries are defined as the "unicode words" defined in the |
| //! `unicode_segmentation` library, as well as within those words in this |
| //! manner: |
| //! |
| //! 1. All underscore characters are considered word boundaries. |
| //! 2. If an uppercase character is followed by lowercase letters, a word |
| //! boundary is considered to be just prior to that uppercase character. |
| //! 3. If multiple uppercase characters are consecutive, they are considered to |
| //! be within a single word, except that the last will be part of the next word |
| //! if it is followed by lowercase characters (see rule 2). |
| //! |
| //! That is, "HelloWorld" is segmented `Hello|World` whereas "XMLHttpRequest" is |
| //! segmented `XML|Http|Request`. |
| //! |
| //! Characters not within words (such as spaces, punctuations, and underscores) |
| //! are not included in the output string except as they are a part of the case |
| //! being converted to. Multiple adjacent word boundaries (such as a series of |
| //! underscores) are folded into one. ("hello__world" in snake case is therefore |
| //! "hello_world", not the exact same string). Leading or trailing word boundary |
| //! indicators are dropped, except insofar as CamelCase capitalizes the first |
| //! word. |
| //! |
| //! ### Cases contained in this library: |
| //! |
| //! 1. CamelCase |
| //! 2. snake_case |
| //! 3. kebab-case |
| //! 4. SHOUTY_SNAKE_CASE |
| //! 5. mixedCase |
| //! 6. Title Case |
| //! 7. SHOUTY-KEBAB-CASE |
| </span><span class="attribute">#![deny(missing_docs)] |
| |
| </span><span class="kw">mod </span>camel; |
| <span class="kw">mod </span>kebab; |
| <span class="kw">mod </span>mixed; |
| <span class="kw">mod </span>shouty_kebab; |
| <span class="kw">mod </span>shouty_snake; |
| <span class="kw">mod </span>snake; |
| <span class="kw">mod </span>title; |
| |
| <span class="kw">pub use </span>camel::CamelCase; |
| <span class="kw">pub use </span>kebab::KebabCase; |
| <span class="kw">pub use </span>mixed::MixedCase; |
| <span class="kw">pub use </span>shouty_kebab::ShoutyKebabCase; |
| <span class="kw">pub use </span>shouty_snake::{ShoutySnakeCase, ShoutySnekCase}; |
| <span class="kw">pub use </span>snake::{SnakeCase, SnekCase}; |
| <span class="kw">pub use </span>title::TitleCase; |
| |
| <span class="kw">use </span>unicode_segmentation::UnicodeSegmentation; |
| |
| <span class="kw">fn </span>transform<F, G>(s: <span class="kw-2">&</span>str, with_word: F, boundary: G) -> String |
| <span class="kw">where |
| </span>F: Fn(<span class="kw-2">&</span>str, <span class="kw-2">&mut </span>String), |
| G: Fn(<span class="kw-2">&mut </span>String), |
| { |
| <span class="doccomment">/// Tracks the current 'mode' of the transformation algorithm as it scans |
| /// the input string. |
| /// |
| /// The mode is a tri-state which tracks the case of the last cased |
| /// character of the current word. If there is no cased character |
| /// (either lowercase or uppercase) since the previous word boundary, |
| /// than the mode is `Boundary`. If the last cased character is lowercase, |
| /// then the mode is `Lowercase`. Othertherwise, the mode is |
| /// `Uppercase`. |
| </span><span class="attribute">#[derive(Clone, Copy, PartialEq)] |
| </span><span class="kw">enum </span>WordMode { |
| <span class="doccomment">/// There have been no lowercase or uppercase characters in the current |
| /// word. |
| </span>Boundary, |
| <span class="doccomment">/// The previous cased character in the current word is lowercase. |
| </span>Lowercase, |
| <span class="doccomment">/// The previous cased character in the current word is uppercase. |
| </span>Uppercase, |
| } |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>out = String::new(); |
| <span class="kw">let </span><span class="kw-2">mut </span>first_word = <span class="bool-val">true</span>; |
| |
| <span class="kw">for </span>word <span class="kw">in </span>s.unicode_words() { |
| <span class="kw">let </span><span class="kw-2">mut </span>char_indices = word.char_indices().peekable(); |
| <span class="kw">let </span><span class="kw-2">mut </span>init = <span class="number">0</span>; |
| <span class="kw">let </span><span class="kw-2">mut </span>mode = WordMode::Boundary; |
| |
| <span class="kw">while let </span><span class="prelude-val">Some</span>((i, c)) = char_indices.next() { |
| <span class="comment">// Skip underscore characters |
| </span><span class="kw">if </span>c == <span class="string">'_' </span>{ |
| <span class="kw">if </span>init == i { |
| init += <span class="number">1</span>; |
| } |
| <span class="kw">continue</span>; |
| } |
| |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(<span class="kw-2">&</span>(next_i, next)) = char_indices.peek() { |
| <span class="comment">// The mode including the current character, assuming the |
| // current character does not result in a word boundary. |
| </span><span class="kw">let </span>next_mode = <span class="kw">if </span>c.is_lowercase() { |
| WordMode::Lowercase |
| } <span class="kw">else if </span>c.is_uppercase() { |
| WordMode::Uppercase |
| } <span class="kw">else </span>{ |
| mode |
| }; |
| |
| <span class="comment">// Word boundary after if next is underscore or current is |
| // not uppercase and next is uppercase |
| </span><span class="kw">if </span>next == <span class="string">'_' </span>|| (next_mode == WordMode::Lowercase && next.is_uppercase()) { |
| <span class="kw">if </span>!first_word { |
| boundary(<span class="kw-2">&mut </span>out); |
| } |
| with_word(<span class="kw-2">&</span>word[init..next_i], <span class="kw-2">&mut </span>out); |
| first_word = <span class="bool-val">false</span>; |
| init = next_i; |
| mode = WordMode::Boundary; |
| |
| <span class="comment">// Otherwise if current and previous are uppercase and next |
| // is lowercase, word boundary before |
| </span>} <span class="kw">else if </span>mode == WordMode::Uppercase && c.is_uppercase() && next.is_lowercase() { |
| <span class="kw">if </span>!first_word { |
| boundary(<span class="kw-2">&mut </span>out); |
| } <span class="kw">else </span>{ |
| first_word = <span class="bool-val">false</span>; |
| } |
| with_word(<span class="kw-2">&</span>word[init..i], <span class="kw-2">&mut </span>out); |
| init = i; |
| mode = WordMode::Boundary; |
| |
| <span class="comment">// Otherwise no word boundary, just update the mode |
| </span>} <span class="kw">else </span>{ |
| mode = next_mode; |
| } |
| } <span class="kw">else </span>{ |
| <span class="comment">// Collect trailing characters as a word |
| </span><span class="kw">if </span>!first_word { |
| boundary(<span class="kw-2">&mut </span>out); |
| } <span class="kw">else </span>{ |
| first_word = <span class="bool-val">false</span>; |
| } |
| with_word(<span class="kw-2">&</span>word[init..], <span class="kw-2">&mut </span>out); |
| <span class="kw">break</span>; |
| } |
| } |
| } |
| |
| out |
| } |
| |
| <span class="kw">fn </span>lowercase(s: <span class="kw-2">&</span>str, out: <span class="kw-2">&mut </span>String) { |
| <span class="kw">let </span><span class="kw-2">mut </span>chars = s.chars().peekable(); |
| <span class="kw">while let </span><span class="prelude-val">Some</span>(c) = chars.next() { |
| <span class="kw">if </span>c == <span class="string">'Σ' </span>&& chars.peek().is_none() { |
| out.push(<span class="string">'ς'</span>); |
| } <span class="kw">else </span>{ |
| out.extend(c.to_lowercase()); |
| } |
| } |
| } |
| |
| <span class="kw">fn </span>uppercase(s: <span class="kw-2">&</span>str, out: <span class="kw-2">&mut </span>String) { |
| <span class="kw">for </span>c <span class="kw">in </span>s.chars() { |
| out.extend(c.to_uppercase()) |
| } |
| } |
| |
| <span class="kw">fn </span>capitalize(s: <span class="kw-2">&</span>str, out: <span class="kw-2">&mut </span>String) { |
| <span class="kw">let </span><span class="kw-2">mut </span>char_indices = s.char_indices(); |
| <span class="kw">if let </span><span class="prelude-val">Some</span>((<span class="kw">_</span>, c)) = char_indices.next() { |
| out.extend(c.to_uppercase()); |
| <span class="kw">if let </span><span class="prelude-val">Some</span>((i, <span class="kw">_</span>)) = char_indices.next() { |
| lowercase(<span class="kw-2">&</span>s[i..], out); |
| } |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="heck" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
