mirror of
https://github.com/edg-l/edlang.git
synced 2024-11-09 09:38:24 +00:00
13 lines
6.6 KiB
HTML
13 lines
6.6 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="This trait defines a train case conversion."><title>ToTrainCase in 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="sidebar-items.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 trait"><!--[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><h2 class="location"><a href="#">ToTrainCase</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.to_train_case">to_train_case</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-ToTrainCase-for-str">str</a></li></ul><h3><a href="#object-safety">Object Safety</a></h3><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In crate heck</a></h2></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>Trait <a href="index.html">heck</a>::<wbr><a class="trait" href="#">ToTrainCase</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/train.rs.html#20-23">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub trait ToTrainCase: <a class="trait" href="https://doc.rust-lang.org/1.80.0/alloc/borrow/trait.ToOwned.html" title="trait alloc::borrow::ToOwned">ToOwned</a> {
|
|
// Required method
|
|
fn <a href="#tymethod.to_train_case" class="fn">to_train_case</a>(&self) -> Self::<a class="associatedtype" href="https://doc.rust-lang.org/1.80.0/alloc/borrow/trait.ToOwned.html#associatedtype.Owned" title="type alloc::borrow::ToOwned::Owned">Owned</a>;
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>This trait defines a train case conversion.</p>
|
|
<p>In Train-Case, word boundaries are indicated by hyphens and words start
|
|
with Capital Letters.</p>
|
|
<h3 id="example"><a class="doc-anchor" href="#example">§</a>Example:</h3>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>heck::ToTrainCase;
|
|
|
|
<span class="kw">let </span>sentence = <span class="string">"We are going to inherit the earth."</span>;
|
|
<span class="macro">assert_eq!</span>(sentence.to_train_case(), <span class="string">"We-Are-Going-To-Inherit-The-Earth"</span>);</code></pre></div>
|
|
</div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.to_train_case" class="method"><a class="src rightside" href="../src/heck/train.rs.html#22">source</a><h4 class="code-header">fn <a href="#tymethod.to_train_case" class="fn">to_train_case</a>(&self) -> Self::<a class="associatedtype" href="https://doc.rust-lang.org/1.80.0/alloc/borrow/trait.ToOwned.html#associatedtype.Owned" title="type alloc::borrow::ToOwned::Owned">Owned</a></h4></section></summary><div class="docblock"><p>Convert this type to Train-Case.</p>
|
|
</div></details></div><h2 id="object-safety" class="section-header">Object Safety<a href="#object-safety" class="anchor">§</a></h2><div class="object-safety-info">This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.80.0/reference/items/traits.html#object-safety">object safe</a>.</div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-ToTrainCase-for-str" class="impl"><a class="src rightside" href="../src/heck/train.rs.html#25-29">source</a><a href="#impl-ToTrainCase-for-str" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.ToTrainCase.html" title="trait heck::ToTrainCase">ToTrainCase</a> for <a class="primitive" href="https://doc.rust-lang.org/1.80.0/core/primitive.str.html">str</a></h3></section></summary><div class="impl-items"><section id="method.to_train_case" class="method trait-impl"><a class="src rightside" href="../src/heck/train.rs.html#26-28">source</a><a href="#method.to_train_case" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.to_train_case" class="fn">to_train_case</a>(&self) -> Self::<a class="associatedtype" href="https://doc.rust-lang.org/1.80.0/alloc/borrow/trait.ToOwned.html#associatedtype.Owned" title="type alloc::borrow::ToOwned::Owned">Owned</a></h4></section></div></details><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../trait.impl/heck/train/trait.ToTrainCase.js" data-ignore-extern-crates="core" async></script></section></div></main></body></html> |