edg-l/edlang
1
1
Fork 0
mirror of https://github.com/edg-l/edlang.git synced 2024-11-23 00:18:24 +00:00
Code Issues Packages Projects Releases Wiki Activity
edlang/heck/index.html

38 lines
12 KiB
HTML
Raw Normal View History

deploy: b3bd34a9bbae9c73eb2d66a212d6921bd7499b69
2024-07-26 09:42:18 +00:00
<!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="heck is a case conversion library."><title>heck - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-dd39b87e5fcfba68.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="heck" data-themes="" data-resource-suffix="" data-rustdoc-version="1.80.0 (051478957 2024-07-21)" data-channel="1.80.0" data-search-js="search-d52510db62a78183.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-118b08c4c78b968e.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-df360f571f6edeae.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../heck/index.html">heck</a><span class="version">0.5.0</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li></ul></section></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Crate <a class="mod" href="#">heck</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../src/heck/lib.rs.html#1-192">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><strong>heck</strong> is a case conversion library.</p>
deploy: 4a83cfd6f9c58b14a87234162281aad1aef83c3e
2024-02-13 06:38:44 +00:00
<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>
deploy: 39fc7f2b9fd58ce67982b1c71c788f3b031ae3df
2024-03-27 11:12:16 +00:00
<h3 id="definition-of-a-word-boundary"><a class="doc-anchor" href="#definition-of-a-word-boundary">§</a>Definition of a word boundary</h3>
deploy: 4aa8b2078ee7e45a1b198e8bd15994bab33a30b1
2024-03-27 11:50:56 +00:00
<p>Word boundaries are defined by non-alphanumeric characters, as well as
within those words in this manner:</p>
deploy: 4a83cfd6f9c58b14a87234162281aad1aef83c3e
2024-02-13 06:38:44 +00:00
<ol>
<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
deploy: 4aa8b2078ee7e45a1b198e8bd15994bab33a30b1
2024-03-27 11:50:56 +00:00
if it is followed by lowercase characters (see rule 1).</li>
deploy: 4a83cfd6f9c58b14a87234162281aad1aef83c3e
2024-02-13 06:38:44 +00:00
</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>
deploy: 39fc7f2b9fd58ce67982b1c71c788f3b031ae3df
2024-03-27 11:12:16 +00:00
<h4 id="cases-contained-in-this-library"><a class="doc-anchor" href="#cases-contained-in-this-library">§</a>Cases contained in this library:</h4>
deploy: 4a83cfd6f9c58b14a87234162281aad1aef83c3e
2024-02-13 06:38:44 +00:00
<ol>
<li>UpperCamelCase</li>
<li>lowerCamelCase</li>
<li>snake_case</li>
<li>kebab-case</li>
<li>SHOUTY_SNAKE_CASE</li>
<li>Title Case</li>
<li>SHOUTY-KEBAB-CASE</li>
<li>Train-Case</li>
</ol>
deploy: b3bd34a9bbae9c73eb2d66a212d6921bd7499b69
2024-07-26 09:42:18 +00:00
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.AsKebabCase.html" title="struct heck::AsKebabCase">AsKebabCase</a></div><div class="desc docblock-short">This wrapper performs a kebab case conversion in <a href="https://doc.rust-lang.org/1.80.0/core/fmt/trait.Display.html" title="trait core::fmt::Display"><code>fmt::Display</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.AsLowerCamelCase.html" title="struct heck::AsLowerCamelCase">AsLowerCamelCase</a></div><div class="desc docblock-short">This wrapper performs a lower camel case conversion in <a href="https://doc.rust-lang.org/1.80.0/core/fmt/trait.Display.html" title="trait core::fmt::Display"><code>fmt::Display</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.AsPascalCase.html" title="struct heck::AsPascalCase">AsPascalCase</a></div><div class="desc docblock-short">This wrapper performs a upper camel case conversion in <a href="https://doc.rust-lang.org/1.80.0/core/fmt/trait.Display.html" title="trait core::fmt::Display"><code>fmt::Display</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.AsShoutyKebabCase.html" title="struct heck::AsShoutyKebabCase">AsShoutyKebabCase</a></div><div class="desc docblock-short">This wrapper performs a kebab case conversion in <a href="https://doc.rust-lang.org/1.80.0/core/fmt/trait.Display.html" title="trait core::fmt::Display"><code>fmt::Display</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.AsShoutySnakeCase.html" title="struct heck::AsShoutySnakeCase">AsShoutySnakeCase</a></div><div class="desc docblock-short">This wrapper performs a shouty snake case conversion in <a href="https://doc.rust-lang.org/1.80.0/core/fmt/trait.Display.html" title="trait core::fmt::Display"><code>fmt::Display</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.AsShoutySnekCase.html" title="struct heck::AsShoutySnekCase">AsShoutySnekCase</a></div><div class="desc docblock-short">This wrapper performs a shouty snake case conversion in <a href="https://doc.rust-lang.org/1.80.0/core/fmt/trait.Display.html" title="trait core::fmt::Display"><code>fmt::Display</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.AsSnakeCase.html" title="struct heck::AsSnakeCase">AsSnakeCase</a></div><div class="desc docblock-short">This wrapper performs a snake case conversion in <a href="https://doc.rust-lang.org/1.80.0/core/fmt/trait.Display.html" title="trait core::fmt::Display"><code>fmt::Display</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.AsSnekCase.html" title="struct heck::AsSnekCase">AsSnekCase</a></div><div class="desc docblock-short">This wrapper performs a snake case conversion in <a href="https://doc.rust-lang.org/1.80.0/core/fmt/trait.Display.html" title="trait core::fmt::Display"><code>fmt::Display</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.AsTitleCase.html" title="struct heck::AsTitleCase">AsTitleCase</a></div><div class="desc docblock-short">This wrapper performs a title case conversion in <a href="https://doc.rust-lang.org/1.80.0/core/fmt/trait.Display.html" title="trait core::fmt::Display"><code>fmt::Display</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.AsTrainCase.html" title="struct heck::AsTrainCase">AsTrainCase</a></div><div class="desc docblock-short">This wrapper performs a train case conversion in <a href="https://doc.rust-lang.org/1.80.0/core/fmt/trait.Display.html" title="trait core::fmt::Display"><code>fmt::Display</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.AsUpperCamelCase.html" title="struct heck::AsUpperCamelCase">AsUpperCamelCase</a></div><div class="desc docblock-short">This wrapper performs a upper camel case conversion in <a href="https://doc.rust-lang.org/1.80.0/core/fmt/trait.Display.ht
deploy: 4aa8b2078ee7e45a1b198e8bd15994bab33a30b1
2024-03-27 11:50:56 +00:00
documentation.</div></li><li><div class="item-name"><a class="trait" href="trait.ToShoutyKebabCase.html" title="trait heck::ToShoutyKebabCase">ToShoutyKebabCase</a></div><div class="desc docblock-short">This trait defines a shouty kebab case conversion.</div></li><li><div class="item-name"><a class="trait" href="trait.ToShoutySnakeCase.html" title="trait heck::ToShoutySnakeCase">ToShoutySnakeCase</a></div><div class="desc docblock-short">This trait defines a shouty snake case conversion.</div></li><li><div class="item-name"><a class="trait" href="trait.ToShoutySnekCase.html" title="trait heck::ToShoutySnekCase">ToShoutySnekCase</a></div><div class="desc docblock-short">Oh heck, <code>ToShoutySnekCase</code> is an alias for <a href="trait.ToShoutySnakeCase.html" title="trait heck::ToShoutySnakeCase"><code>ToShoutySnakeCase</code></a>. See
ToShoutySnakeCase for more documentation.</div></li><li><div class="item-name"><a class="trait" href="trait.ToSnakeCase.html" title="trait heck::ToSnakeCase">ToSnakeCase</a></div><div class="desc docblock-short">This trait defines a snake case conversion.</div></li><li><div class="item-name"><a class="trait" href="trait.ToSnekCase.html" title="trait heck::ToSnekCase">ToSnekCase</a></div><div class="desc docblock-short">Oh heck, <code>SnekCase</code> is an alias for <a href="trait.ToSnakeCase.html" title="trait heck::ToSnakeCase"><code>ToSnakeCase</code></a>. See ToSnakeCase for
deploy: 4a83cfd6f9c58b14a87234162281aad1aef83c3e
2024-02-13 06:38:44 +00:00
more documentation.</div></li><li><div class="item-name"><a class="trait" href="trait.ToTitleCase.html" title="trait heck::ToTitleCase">ToTitleCase</a></div><div class="desc docblock-short">This trait defines a title case conversion.</div></li><li><div class="item-name"><a class="trait" href="trait.ToTrainCase.html" title="trait heck::ToTrainCase">ToTrainCase</a></div><div class="desc docblock-short">This trait defines a train case conversion.</div></li><li><div class="item-name"><a class="trait" href="trait.ToUpperCamelCase.html" title="trait heck::ToUpperCamelCase">ToUpperCamelCase</a></div><div class="desc docblock-short">This trait defines an upper camel case conversion.</div></li></ul></section></div></main></body></html>
Reference in a new issue Copy permalink