mirror of
https://github.com/fluencelabs/wasmer
synced 2025-04-25 10:22:19 +00:00
44 lines
7.7 KiB
HTML
44 lines
7.7 KiB
HTML
<!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 `heck` crate."><meta name="keywords" content="rust, rustlang, rust-lang, heck"><title>heck - 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="../dark.css"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><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='../heck/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Crate heck</p><div class="sidebar-elems"><a id='all-types' href='all.html'><p>See all heck's items</p></a><div class="block items"><ul><li><a href="#traits">Traits</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'heck', ty: 'mod', relpath: '../'};</script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><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/heck/lib.rs.html#1-165' title='goto source code'>[src]</a></span><span class='in-band'>Crate <a class="mod" href=''>heck</a></span></h1><div class='docblock'><p><strong>heck</strong> is a case conversion library.</p>
|
||
<p>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.</p>
|
||
<h2 id="definition-of-a-word-boundary" class="section-header"><a href="#definition-of-a-word-boundary">Definition of a word boundary</a></h2>
|
||
<p>Word boundaries are defined as the "unicode words" defined in the
|
||
<code>unicode_segmentation</code> library, as well as within those words in this manner:</p>
|
||
<ol>
|
||
<li>All underscore characters are considered word boundaries.</li>
|
||
<li>If an uppercase character is followed by lowercase letters, a word boundary
|
||
is considered to be just prior to that uppercase character.</li>
|
||
<li>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).</li>
|
||
</ol>
|
||
<p>That is, "HelloWorld" is segmented <code>Hello|World</code> whereas "XMLHttpRequest" is
|
||
segmented <code>XML|Http|Request</code>.</p>
|
||
<p>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.</p>
|
||
<h3 id="cases-contained-in-this-library" class="section-header"><a href="#cases-contained-in-this-library">Cases contained in this library:</a></h3>
|
||
<ol>
|
||
<li>CamelCase</li>
|
||
<li>snake_case</li>
|
||
<li>kebab-case</li>
|
||
<li>SHOUTY_SNAKE_CASE</li>
|
||
<li>mixedCase</li>
|
||
<li>Title Case</li>
|
||
</ol>
|
||
</div><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
|
||
<table><tr class='module-item'><td><a class="trait" href="trait.CamelCase.html" title='heck::CamelCase trait'>CamelCase</a></td><td class='docblock-short'><p>This trait defines a camel case conversion.</p>
|
||
</td></tr><tr class='module-item'><td><a class="trait" href="trait.KebabCase.html" title='heck::KebabCase trait'>KebabCase</a></td><td class='docblock-short'><p>This trait defines a kebab case conversion.</p>
|
||
</td></tr><tr class='module-item'><td><a class="trait" href="trait.MixedCase.html" title='heck::MixedCase trait'>MixedCase</a></td><td class='docblock-short'><p>This trait defines a mixed case conversion.</p>
|
||
</td></tr><tr class='module-item'><td><a class="trait" href="trait.ShoutySnakeCase.html" title='heck::ShoutySnakeCase trait'>ShoutySnakeCase</a></td><td class='docblock-short'><p>This trait defines a shouty snake case conversion.</p>
|
||
</td></tr><tr class='module-item'><td><a class="trait" href="trait.ShoutySnekCase.html" title='heck::ShoutySnekCase trait'>ShoutySnekCase</a></td><td class='docblock-short'><p>Oh heck, ShoutySnekCase is an alias for ShoutySnakeCase. See ShoutySnakeCase for
|
||
more documentation.</p>
|
||
</td></tr><tr class='module-item'><td><a class="trait" href="trait.SnakeCase.html" title='heck::SnakeCase trait'>SnakeCase</a></td><td class='docblock-short'><p>This trait defines a camel case conversion.</p>
|
||
</td></tr><tr class='module-item'><td><a class="trait" href="trait.SnekCase.html" title='heck::SnekCase trait'>SnekCase</a></td><td class='docblock-short'><p>Oh heck, SnekCase is an alias for SnakeCase. See SnakeCase for
|
||
more documentation.</p>
|
||
</td></tr><tr class='module-item'><td><a class="trait" href="trait.TitleCase.html" title='heck::TitleCase trait'>TitleCase</a></td><td class='docblock-short'><p>This trait defines a title case conversion.</p>
|
||
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../";window.currentCrate = "heck";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |