Auto Generated Documentation
This commit is contained in:
github-actions[bot]
@@ -1,5 +1,5 @@
|
||||
<!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="API documentation for the Rust `to_text_fmt` fn in crate `ntext`."><meta name="keywords" content="rust, rustlang, rust-lang, to_text_fmt"><title>ntext::to_text_fmt - 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><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg">
|
||||
<link rel="alternate icon" type="image/png" href="../favicon-16x16.png">
|
||||
<link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc fn"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../ntext/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><div class="sidebar-elems"><p class="location"><a href="index.html">ntext</a></p><script>window.sidebarCurrent = {name: "to_text_fmt", ty: "fn", relpath: ""};</script><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"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../theme.js"></script><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" class="help-button">?</button>
|
||||
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><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/ntext/numtext.rs.html#139-177" title="goto source code">[src]</a></span><span class="in-band">Function <a href="index.html">ntext</a>::<wbr><a class="fn" href="">to_text_fmt</a></span></h1><pre class="rust fn">pub fn to_text_fmt(number: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, fmt: &<a class="struct" href="../ntext/struct.Formatting.html" title="struct ntext::Formatting">Formatting</a><'_>) -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></pre><div class="docblock"><p>Convert usize to words in a string seperated by a seperator.</p>
|
||||
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><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/ntext/numtext.rs.html#151-189" title="goto source code">[src]</a></span><span class="in-band">Function <a href="index.html">ntext</a>::<wbr><a class="fn" href="">to_text_fmt</a></span></h1><pre class="rust fn">pub fn to_text_fmt(number: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, fmt: &<a class="struct" href="../ntext/struct.Formatting.html" title="struct ntext::Formatting">Formatting</a><'_>) -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></pre><div class="docblock"><p>Convert usize to words in a string seperated by a seperator.</p>
|
||||
</div></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../";window.currentCrate = "ntext";</script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>
|
||||
@@ -14,7 +14,7 @@
|
||||
</div><span id="structfield.tens_seperator" class="structfield small-section-header"><a href="#structfield.tens_seperator" class="anchor field"></a><code>tens_seperator: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'format <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>></code></span><div class="docblock"><p>Set the seperator between tens place digits like "twenty-two".</p>
|
||||
</div><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><h3 id="impl" class="impl"><code class="in-band">impl<'format> <a class="struct" href="../ntext/struct.Formatting.html" title="struct ntext::Formatting">Formatting</a><'format></code><a href="#impl" class="anchor"></a><a class="srclink" href="../src/ntext/formatting.rs.html#14-62" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.default" class="method"><code>pub fn <a href="#method.default" class="fnname">default</a>() -> Self</code><a class="srclink" href="../src/ntext/formatting.rs.html#16-23" title="goto source code">[src]</a></h4><div class="docblock"><p>Get the default formatting.</p>
|
||||
</div><h4 id="method.none" class="method"><code>pub fn <a href="#method.none" class="fnname">none</a>() -> Self</code><a class="srclink" href="../src/ntext/formatting.rs.html#25-32" title="goto source code">[src]</a></h4><div class="docblock"><p>No formatting at all</p>
|
||||
</div><h4 id="method.with_seperator" class="method"><code>pub fn <a href="#method.with_seperator" class="fnname">with_seperator</a>(seperator: &'format <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> Self</code><a class="srclink" href="../src/ntext/formatting.rs.html#34-41" title="goto source code">[src]</a></h4><div class="docblock"><p>With same formatting for all</p>
|
||||
</div><h4 id="method.with_seperator" class="method"><code>pub fn <a href="#method.with_seperator" class="fnname">with_seperator</a>(seperator: &'format <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> Self</code><a class="srclink" href="../src/ntext/formatting.rs.html#34-41" title="goto source code">[src]</a></h4><div class="docblock"><p>With same formatting for all seperators</p>
|
||||
</div><h4 id="method.capitalize" class="method"><code>pub fn <a href="#method.capitalize" class="fnname">capitalize</a>(&mut self) -> Self</code><a class="srclink" href="../src/ntext/formatting.rs.html#43-51" title="goto source code">[src]</a></h4><div class="docblock"><p>Capitalize the formatting</p>
|
||||
</div><h4 id="method.decapitalize" class="method"><code>pub fn <a href="#method.decapitalize" class="fnname">decapitalize</a>(&mut self) -> Self</code><a class="srclink" href="../src/ntext/formatting.rs.html#53-61" title="goto source code">[src]</a></h4><div class="docblock"><p>Lower case the formatting struct</p>
|
||||
</div></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><h3 id="impl-Clone" class="impl"><code class="in-band">impl<'format> <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../ntext/struct.Formatting.html" title="struct ntext::Formatting">Formatting</a><'format></code><a href="#impl-Clone" class="anchor"></a><a class="srclink" href="../src/ntext/formatting.rs.html#2" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.clone" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone" class="fnname">clone</a>(&self) -> <a class="struct" href="../ntext/struct.Formatting.html" title="struct ntext::Formatting">Formatting</a><'format></code><a class="srclink" href="../src/ntext/formatting.rs.html#2" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
var searchIndex = JSON.parse('{\
|
||||
"ntext":{"doc":"Example program with default formatting","i":[[3,"Formatting","ntext","Set the formatting of the output ",null,null],[12,"capitalize","","capitalize the start of the word.",0,null],[12,"digit_seperator","","Set the seperator in between digits like …",0,null],[12,"place_seperator","","Set the seperator in between words like \\\"three/hundred\\\".",0,null],[12,"tens_seperator","","Set the seperator between tens place digits like …",0,null],[5,"digit_to_text","","Convert digit to words in a string.",null,[[],[["option",4],["string",3]]]],[5,"to_text_fmt","","Convert usize to words in a string seperated by a …",null,[[["formatting",3]],["string",3]]],[14,"to_text","","Macro which supports both seperator and without it",null,null],[11,"from","","",0,[[]]],[11,"into","","",0,[[]]],[11,"to_owned","","",0,[[]]],[11,"clone_into","","",0,[[]]],[11,"borrow","","",0,[[]]],[11,"borrow_mut","","",0,[[]]],[11,"try_from","","",0,[[],["result",4]]],[11,"try_into","","",0,[[],["result",4]]],[11,"type_id","","",0,[[],["typeid",3]]],[11,"clone","","",0,[[],["formatting",3]]],[11,"default","","Get the default formatting.",0,[[]]],[11,"none","","No formatting at all",0,[[]]],[11,"with_seperator","","With same formatting for all",0,[[]]],[11,"capitalize","","Capitalize the formatting",0,[[]]],[11,"decapitalize","","Lower case the formatting struct",0,[[]]]],"p":[[3,"Formatting"]]}\
|
||||
"ntext":{"doc":"Example program with default formatting","i":[[3,"Formatting","ntext","Set the formatting of the output ",null,null],[12,"capitalize","","capitalize the start of the word.",0,null],[12,"digit_seperator","","Set the seperator in between digits like …",0,null],[12,"place_seperator","","Set the seperator in between words like \\\"three/hundred\\\".",0,null],[12,"tens_seperator","","Set the seperator between tens place digits like …",0,null],[5,"digit_to_text","","Convert digit to words in a string.",null,[[],[["option",4],["string",3]]]],[5,"to_text_fmt","","Convert usize to words in a string seperated by a …",null,[[["formatting",3]],["string",3]]],[14,"to_text","","Macro which supports both seperator and without it",null,null],[11,"from","","",0,[[]]],[11,"into","","",0,[[]]],[11,"to_owned","","",0,[[]]],[11,"clone_into","","",0,[[]]],[11,"borrow","","",0,[[]]],[11,"borrow_mut","","",0,[[]]],[11,"try_from","","",0,[[],["result",4]]],[11,"try_into","","",0,[[],["result",4]]],[11,"type_id","","",0,[[],["typeid",3]]],[11,"clone","","",0,[[],["formatting",3]]],[11,"default","","Get the default formatting.",0,[[]]],[11,"none","","No formatting at all",0,[[]]],[11,"with_seperator","","With same formatting for all seperators",0,[[]]],[11,"capitalize","","Capitalize the formatting",0,[[]]],[11,"decapitalize","","Lower case the formatting struct",0,[[]]]],"p":[[3,"Formatting"]]}\
|
||||
}');
|
||||
addSearchOptions(searchIndex);initSearch(searchIndex);
|
||||
@@ -96,7 +96,7 @@
|
||||
<span class="ident">tens_seperator</span>: <span class="prelude-val">None</span>,
|
||||
}
|
||||
}
|
||||
<span class="doccomment">/// With same formatting for all</span>
|
||||
<span class="doccomment">/// With same formatting for all seperators</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">with_seperator</span>(<span class="ident">seperator</span>: <span class="kw-2">&</span><span class="lifetime">'format</span> <span class="ident">str</span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span> {
|
||||
<span class="self">Self</span> {
|
||||
<span class="ident">capitalize</span>: <span class="bool-val">false</span>,
|
||||
|
||||
@@ -178,6 +178,18 @@
|
||||
<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>
|
||||
<span id="182">182</span>
|
||||
<span id="183">183</span>
|
||||
<span id="184">184</span>
|
||||
<span id="185">185</span>
|
||||
<span id="186">186</span>
|
||||
<span id="187">187</span>
|
||||
<span id="188">188</span>
|
||||
<span id="189">189</span>
|
||||
</pre><div class="example-wrap"><pre class="rust ">
|
||||
<span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">Formatting</span>;
|
||||
|
||||
@@ -228,6 +240,12 @@
|
||||
<span class="number">4</span> <span class="op">=</span><span class="op">></span> <span class="ident">buffer</span>.<span class="ident">push_str</span>(<span class="string">"Thousand"</span>),
|
||||
<span class="number">5</span> <span class="op">=</span><span class="op">></span> (), <span class="comment">// Souldn't happen</span>
|
||||
<span class="number">6</span> <span class="op">=</span><span class="op">></span> <span class="ident">buffer</span>.<span class="ident">push_str</span>(<span class="string">"Million"</span>),
|
||||
<span class="number">7</span> <span class="op">=</span><span class="op">></span> (),
|
||||
<span class="number">8</span> <span class="op">=</span><span class="op">></span> (),
|
||||
<span class="number">9</span> <span class="op">=</span><span class="op">></span> <span class="ident">buffer</span>.<span class="ident">push_str</span>(<span class="string">"Billion"</span>),
|
||||
<span class="number">10</span> <span class="op">=</span><span class="op">></span> (),
|
||||
<span class="number">11</span> <span class="op">=</span><span class="op">></span> (),
|
||||
<span class="number">12</span> <span class="op">=</span><span class="op">></span> <span class="ident">buffer</span>.<span class="ident">push_str</span>(<span class="string">"Trillion"</span>),
|
||||
<span class="kw">_</span> <span class="op">=</span><span class="op">></span> (),
|
||||
};
|
||||
} <span class="kw">else</span> {
|
||||
@@ -238,6 +256,12 @@
|
||||
<span class="number">4</span> <span class="op">=</span><span class="op">></span> <span class="ident">buffer</span>.<span class="ident">push_str</span>(<span class="string">"thousand"</span>),
|
||||
<span class="number">5</span> <span class="op">=</span><span class="op">></span> (), <span class="comment">// Souldn't happen</span>
|
||||
<span class="number">6</span> <span class="op">=</span><span class="op">></span> <span class="ident">buffer</span>.<span class="ident">push_str</span>(<span class="string">"million"</span>),
|
||||
<span class="number">7</span> <span class="op">=</span><span class="op">></span> (),
|
||||
<span class="number">8</span> <span class="op">=</span><span class="op">></span> (),
|
||||
<span class="number">9</span> <span class="op">=</span><span class="op">></span> <span class="ident">buffer</span>.<span class="ident">push_str</span>(<span class="string">"billion"</span>),
|
||||
<span class="number">10</span> <span class="op">=</span><span class="op">></span> (),
|
||||
<span class="number">11</span> <span class="op">=</span><span class="op">></span> (),
|
||||
<span class="number">12</span> <span class="op">=</span><span class="op">></span> <span class="ident">buffer</span>.<span class="ident">push_str</span>(<span class="string">"trillion"</span>),
|
||||
<span class="kw">_</span> <span class="op">=</span><span class="op">></span> (),
|
||||
}
|
||||
}
|
||||
@@ -320,7 +344,7 @@
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">to_text_fmt</span>(<span class="ident">number</span>: <span class="ident">usize</span>, <span class="ident">fmt</span>: <span class="kw-2">&</span><span class="ident">Formatting</span>) <span class="op">-</span><span class="op">></span> <span class="ident">String</span> {
|
||||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">numtext</span>: <span class="ident">String</span> <span class="op">=</span> <span class="ident">String</span>::<span class="ident">new</span>();
|
||||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">last</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">u8</span><span class="op">></span> <span class="op">=</span> <span class="prelude-val">None</span>;
|
||||
<span class="kw">let</span> <span class="ident">tens_place_holders</span>: [<span class="ident">u8</span>; <span class="number">3</span>] <span class="op">=</span> [<span class="number">2</span>, <span class="number">5</span>, <span class="number">7</span>];
|
||||
<span class="kw">let</span> <span class="ident">tens_place_holders</span>: [<span class="ident">u8</span>; <span class="number">4</span>] <span class="op">=</span> [<span class="number">2</span>, <span class="number">5</span>, <span class="number">7</span>, <span class="number">10</span>];
|
||||
<span class="kw">let</span> <span class="ident">digits</span>: <span class="ident">Vec</span><span class="op"><</span><span class="ident">u8</span><span class="op">></span> <span class="op">=</span> <span class="ident">number</span>
|
||||
.<span class="ident">to_string</span>()
|
||||
.<span class="ident">chars</span>()
|
||||
|
||||
Reference in New Issue
Block a user