Auto Generated Documentation
This commit is contained in:
github-actions[bot]
@@ -1,8 +1,7 @@
|
||||
<!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 `ntext` crate."><meta name="keywords" content="rust, rustlang, rust-lang, ntext"><title>ntext - 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 mod"><!--[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><p class="location">Crate ntext</p><div class="block version"><p>Version 0.2.1</p></div><div class="sidebar-elems"><a id="all-types" href="all.html"><p>See all ntext's items</p></a><div class="block items"><ul><li><a href="#macros">Macros</a></li><li><a href="#structs">Structs</a></li><li><a href="#functions">Functions</a></li></ul></div><p class="location"></p><script>window.sidebarCurrent = {name: "ntext", ty: "mod", relpath: "../"};</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/lib.rs.html#1-40" title="goto source code">[src]</a></span><span class="in-band">Crate <a class="mod" href="">ntext</a></span></h1><div class="docblock"><p>Example program with default formatting
|
||||
Source <a href="https://github.com/uttarayan21/ntext-rs">ntext-rs</a></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/lib.rs.html#1-40" title="goto source code">[src]</a></span><span class="in-band">Crate <a class="mod" href="">ntext</a></span></h1><div class="docblock"><p>Example program with default formatting</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">ntext</span>;
|
||||
@@ -20,8 +19,9 @@ Source <a href="https://github.com/uttarayan21/ntext-rs">ntext-rs</a></p>
|
||||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="macro">to_text</span><span class="macro">!</span>(<span class="number">1000</span>, <span class="kw-2">&</span><span class="ident">Formatting</span>::<span class="ident">none</span>().<span class="ident">capitalize</span>()),<span class="string">"OneThousand"</span>);
|
||||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="macro">to_text</span><span class="macro">!</span>(<span class="number">34123</span>, <span class="kw-2">&</span><span class="ident">Formatting</span>::<span class="ident">with_seperator</span>(<span class="string">"#"</span>).<span class="ident">capitalize</span>()),<span class="string">"Thirty#Four#Thousand#One#Hundred#Twenty#Three"</span>);
|
||||
}</pre></div>
|
||||
<p>This macro will also return an empty string on input zero
|
||||
You can also create the Formatting struct manually</p>
|
||||
<p>This macro will also return an empty string on input zero<br />
|
||||
You can also create the Formatting struct manually<br />
|
||||
Source <a href="https://github.com/uttarayan21/ntext-rs">ntext-rs</a> </p>
|
||||
</div><h2 id="macros" class="section-header"><a href="#macros">Macros</a></h2>
|
||||
<table><tr class="module-item"><td><a class="macro" href="macro.to_text.html" title="ntext::to_text macro">to_text</a></td><td class="docblock-short"><p>Macro which supports both seperator and without it</p>
|
||||
</td></tr></table><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2>
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
var searchIndex = JSON.parse('{\
|
||||
"ntext":{"doc":"Example program with default formatting Source ntext-rs","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",0,[[]]],[11,"capitalize","","Capitalize the formatting",0,[[]]],[11,"decapitalize","","Lower case the formatting struct",0,[[]]]],"p":[[3,"Formatting"]]}\
|
||||
}');
|
||||
addSearchOptions(searchIndex);initSearch(searchIndex);
|
||||
@@ -42,8 +42,7 @@
|
||||
<span id="39">39</span>
|
||||
<span id="40">40</span>
|
||||
</pre><div class="example-wrap"><pre class="rust ">
|
||||
<span class="doccomment">//! Example program with default formatting</span>
|
||||
<span class="doccomment">//! Source [ntext-rs](https://github.com/uttarayan21/ntext-rs)</span>
|
||||
<span class="doccomment">//! Example program with default formatting </span>
|
||||
<span class="doccomment">//!```rust</span>
|
||||
<span class="doccomment">//!extern crate ntext;</span>
|
||||
<span class="doccomment">//!use ntext::to_text;</span>
|
||||
@@ -62,8 +61,9 @@
|
||||
<span class="doccomment">//! assert_eq!(to_text!(34123, &Formatting::with_seperator("#").capitalize()),"Thirty#Four#Thousand#One#Hundred#Twenty#Three");</span>
|
||||
<span class="doccomment">//!}</span>
|
||||
<span class="doccomment">//!```</span>
|
||||
<span class="doccomment">//! This macro will also return an empty string on input zero</span>
|
||||
<span class="doccomment">//! You can also create the Formatting struct manually</span>
|
||||
<span class="doccomment">//! This macro will also return an empty string on input zero </span>
|
||||
<span class="doccomment">//! You can also create the Formatting struct manually </span>
|
||||
<span class="doccomment">//! Source [ntext-rs](https://github.com/uttarayan21/ntext-rs) </span>
|
||||
|
||||
<span class="kw">mod</span> <span class="ident">formatting</span>;
|
||||
<span class="kw">mod</span> <span class="ident">numtext</span>;
|
||||
|
||||
Reference in New Issue
Block a user