Google Git
Sign in
apache / incubator-teaclave-website / refs/heads/asf-site / . / api-docs / crates-app / src / heck / shouty_snake.rs.html
blob: 33b05e46f596e75469df43494281ac3c56b93d2c [file] [log] [blame]
<!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/shouty_snake.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>shouty_snake.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>
</pre><pre class="rust"><code><span class="kw">use crate</span>::{transform, uppercase};
<span class="doccomment">/// This trait defines a shouty snake case conversion.
///
/// In SHOUTY_SNAKE_CASE, word boundaries are indicated by underscores and all
/// words are in uppercase.
///
/// ## Example:
///
/// ```rust
/// use heck::ShoutySnakeCase;
///
/// let sentence = &quot;That world is growing in this minute.&quot;;
/// assert_eq!(sentence.to_shouty_snake_case(), &quot;THAT_WORLD_IS_GROWING_IN_THIS_MINUTE&quot;);
/// ```
</span><span class="kw">pub trait </span>ShoutySnakeCase: ToOwned {
<span class="doccomment">/// Convert this type to shouty snake case.
</span><span class="kw">fn </span>to_shouty_snake_case(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="self">Self</span>::Owned;
}
<span class="doccomment">/// Oh heck, ShoutySnekCase is an alias for ShoutySnakeCase. See ShoutySnakeCase
/// for more documentation.
</span><span class="kw">pub trait </span>ShoutySnekCase: ToOwned {
<span class="doccomment">/// CONVERT THIS TYPE TO SNEK CASE.
</span><span class="attribute">#[allow(non_snake_case)]
</span><span class="kw">fn </span>TO_SHOUTY_SNEK_CASE(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="self">Self</span>::Owned;
}
<span class="kw">impl</span>&lt;T: <span class="question-mark">?</span>Sized + ShoutySnakeCase&gt; ShoutySnekCase <span class="kw">for </span>T {
<span class="kw">fn </span>TO_SHOUTY_SNEK_CASE(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="self">Self</span>::Owned {
<span class="self">self</span>.to_shouty_snake_case()
}
}
<span class="kw">impl </span>ShoutySnakeCase <span class="kw">for </span>str {
<span class="kw">fn </span>to_shouty_snake_case(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="self">Self</span>::Owned {
transform(<span class="self">self</span>, uppercase, |s| s.push(<span class="string">&#39;_&#39;</span>))
}
}
<span class="attribute">#[cfg(test)]
</span><span class="kw">mod </span>tests {
<span class="kw">use </span><span class="kw">super</span>::ShoutySnakeCase;
<span class="macro">macro_rules! </span>t {
(<span class="macro-nonterminal">$t</span>:ident : <span class="macro-nonterminal">$s1</span>:expr =&gt; <span class="macro-nonterminal">$s2</span>:expr) =&gt; {
<span class="attribute">#[test]
</span><span class="kw">fn </span><span class="macro-nonterminal">$t</span>() {
<span class="macro">assert_eq!</span>(<span class="macro-nonterminal">$s1</span>.to_shouty_snake_case(), <span class="macro-nonterminal">$s2</span>)
}
};
}
<span class="macro">t!</span>(test1: <span class="string">&quot;CamelCase&quot; </span>=&gt; <span class="string">&quot;CAMEL_CASE&quot;</span>);
<span class="macro">t!</span>(test2: <span class="string">&quot;This is Human case.&quot; </span>=&gt; <span class="string">&quot;THIS_IS_HUMAN_CASE&quot;</span>);
<span class="macro">t!</span>(test3: <span class="string">&quot;MixedUP CamelCase, with some Spaces&quot; </span>=&gt; <span class="string">&quot;MIXED_UP_CAMEL_CASE_WITH_SOME_SPACES&quot;</span>);
<span class="macro">t!</span>(test4: <span class="string">&quot;mixed_up_snake_case with some _spaces&quot; </span>=&gt; <span class="string">&quot;MIXED_UP_SNAKE_CASE_WITH_SOME_SPACES&quot;</span>);
<span class="macro">t!</span>(test5: <span class="string">&quot;kebab-case&quot; </span>=&gt; <span class="string">&quot;KEBAB_CASE&quot;</span>);
<span class="macro">t!</span>(test6: <span class="string">&quot;SHOUTY_SNAKE_CASE&quot; </span>=&gt; <span class="string">&quot;SHOUTY_SNAKE_CASE&quot;</span>);
<span class="macro">t!</span>(test7: <span class="string">&quot;snake_case&quot; </span>=&gt; <span class="string">&quot;SNAKE_CASE&quot;</span>);
<span class="macro">t!</span>(test8: <span class="string">&quot;this-contains_ ALLKinds OfWord_Boundaries&quot; </span>=&gt; <span class="string">&quot;THIS_CONTAINS_ALL_KINDS_OF_WORD_BOUNDARIES&quot;</span>);
<span class="macro">t!</span>(test9: <span class="string">&quot;XΣXΣ baffle&quot; </span>=&gt; <span class="string">&quot;XΣXΣ_BAFFLE&quot;</span>);
<span class="macro">t!</span>(test10: <span class="string">&quot;XMLHttpRequest&quot; </span>=&gt; <span class="string">&quot;XML_HTTP_REQUEST&quot;</span>);
}
</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>