mirror of
https://github.com/Rust-GPU/rust-gpu.git
synced 2026-06-07 10:09:51 +09:00
1467 lines
299 KiB
HTML
1467 lines
299 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="A string with a fixed capacity."><meta name="keywords" content="rust, rustlang, rust-lang, ArrayString"><title>ArrayString in arrayvec - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../normalize.css"><link rel="stylesheet" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../ayu.css" disabled><link rel="stylesheet" href="../dark.css" disabled><link rel="stylesheet" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc struct"><!--[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">☰</button><a class="sidebar-logo" href="../arrayvec/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../arrayvec/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">ArrayString</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.as_mut_str">as_mut_str</a></li><li><a href="#method.as_str">as_str</a></li><li><a href="#method.capacity">capacity</a></li><li><a href="#method.clear">clear</a></li><li><a href="#method.from">from</a></li><li><a href="#method.from_byte_string">from_byte_string</a></li><li><a href="#method.is_empty">is_empty</a></li><li><a href="#method.is_full">is_full</a></li><li><a href="#method.len">len</a></li><li><a href="#method.new">new</a></li><li><a href="#method.new_const">new_const</a></li><li><a href="#method.pop">pop</a></li><li><a href="#method.push">push</a></li><li><a href="#method.push_str">push_str</a></li><li><a href="#method.remaining_capacity">remaining_capacity</a></li><li><a href="#method.remove">remove</a></li><li><a href="#method.set_len">set_len</a></li><li><a href="#method.truncate">truncate</a></li><li><a href="#method.try_push">try_push</a></li><li><a href="#method.try_push_str">try_push_str</a></li><li><a href="#method.zero_filled">zero_filled</a></li></ul><h3><a href="#deref-methods-str">Methods from Deref<Target=str></a></h3><ul class="block"><li><a href="#method.as_bytes">as_bytes</a></li><li><a href="#method.as_bytes_mut">as_bytes_mut</a></li><li><a href="#method.as_mut_ptr">as_mut_ptr</a></li><li><a href="#method.as_ptr">as_ptr</a></li><li><a href="#method.bytes">bytes</a></li><li><a href="#method.ceil_char_boundary">ceil_char_boundary</a></li><li><a href="#method.char_indices">char_indices</a></li><li><a href="#method.chars">chars</a></li><li><a href="#method.contains">contains</a></li><li><a href="#method.encode_utf16">encode_utf16</a></li><li><a href="#method.ends_with">ends_with</a></li><li><a href="#method.eq_ignore_ascii_case">eq_ignore_ascii_case</a></li><li><a href="#method.escape_debug">escape_debug</a></li><li><a href="#method.escape_default">escape_default</a></li><li><a href="#method.escape_unicode">escape_unicode</a></li><li><a href="#method.find">find</a></li><li><a href="#method.floor_char_boundary">floor_char_boundary</a></li><li><a href="#method.get">get</a></li><li><a href="#method.get_mut">get_mut</a></li><li><a href="#method.get_unchecked">get_unchecked</a></li><li><a href="#method.get_unchecked_mut">get_unchecked_mut</a></li><li><a href="#method.is_ascii">is_ascii</a></li><li><a href="#method.is_char_boundary">is_char_boundary</a></li><li><a href="#method.is_empty-1">is_empty</a></li><li><a href="#method.len-1">len</a></li><li><a href="#method.lines">lines</a></li><li><a href="#method.lines_any">lines_any</a></li><li><a href="#method.make_ascii_lowercase">make_ascii_lowercase</a></li><li><a href="#method.make_ascii_uppercase">make_ascii_uppercase</a></li><li><a href="#method.match_indices">match_indices</a></li><li><a href="#method.matches">matches</a></li><li><a href="#method.parse">parse</a></li><li><a href="#method.repeat">repeat</a></li><li><a href="#method.replace">replace</a></li><li><a href="#method.replacen">replacen</a></li><li><a href="#method.rfind">rfind</a></li><li><a href="#method.rmatch_indices">rmatch_indices</a></li><li><a href="#method.rmatches">rmatches</a></li><li><a href="#method.rsplit">rsplit</a></li><li><a href="#method.rsplit_once">rsplit_once</a></li><li><a href="#method.rsplit_terminator">rsplit_terminator</a></li><li><a href="#method.rsplitn">rsplitn</a></li><li><a href="#method.slice_mut_unchecked">slice_mut_unchecked</a></li><li><a href="#method.slice_unchecked">slice_unchecked</a></li><li><a href="#method.split">split</a></li><li><a href="#method.split_ascii_whitespace">split_ascii_whitespace</a></li><li><a href="#method.split_at">split_at</a></li><li><a href="#method.split_at_mut">split_at_mut</a></li><li><a href="#method.split_inclusive">split_inclusive</a></li><li><a href="#method.split_once">split_once</a></li><li><a href="#method.split_terminator">split_terminator</a></li><li><a href="#method.split_whitespace">split_whitespace</a></li><li><a href="#method.splitn">splitn</a></li><li><a href="#method.starts_with">starts_with</a></li><li><a href="#method.strip_prefix">strip_prefix</a></li><li><a href="#method.strip_suffix">strip_suffix</a></li><li><a href="#method.to_ascii_lowercase">to_ascii_lowercase</a></li><li><a href="#method.to_ascii_uppercase">to_ascii_uppercase</a></li><li><a href="#method.to_lowercase">to_lowercase</a></li><li><a href="#method.to_uppercase">to_uppercase</a></li><li><a href="#method.trim">trim</a></li><li><a href="#method.trim_end">trim_end</a></li><li><a href="#method.trim_end_matches">trim_end_matches</a></li><li><a href="#method.trim_left">trim_left</a></li><li><a href="#method.trim_left_matches">trim_left_matches</a></li><li><a href="#method.trim_matches">trim_matches</a></li><li><a href="#method.trim_right">trim_right</a></li><li><a href="#method.trim_right_matches">trim_right_matches</a></li><li><a href="#method.trim_start">trim_start</a></li><li><a href="#method.trim_start_matches">trim_start_matches</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-AsRef%3Cstr%3E-for-ArrayString%3CCAP%3E">AsRef<str></a></li><li><a href="#impl-Borrow%3Cstr%3E-for-ArrayString%3CCAP%3E">Borrow<str></a></li><li><a href="#impl-Clone-for-ArrayString%3CCAP%3E">Clone</a></li><li><a href="#impl-Copy-for-ArrayString%3CCAP%3E">Copy</a></li><li><a href="#impl-Debug-for-ArrayString%3CCAP%3E">Debug</a></li><li><a href="#impl-Default-for-ArrayString%3CCAP%3E">Default</a></li><li><a href="#impl-Deref-for-ArrayString%3CCAP%3E">Deref</a></li><li><a href="#impl-DerefMut-for-ArrayString%3CCAP%3E">DerefMut</a></li><li><a href="#impl-Display-for-ArrayString%3CCAP%3E">Display</a></li><li><a href="#impl-Eq-for-ArrayString%3CCAP%3E">Eq</a></li><li><a href="#impl-FromStr-for-ArrayString%3CCAP%3E">FromStr</a></li><li><a href="#impl-Hash-for-ArrayString%3CCAP%3E">Hash</a></li><li><a href="#impl-Ord-for-ArrayString%3CCAP%3E">Ord</a></li><li><a href="#impl-PartialEq%3CArrayString%3CCAP%3E%3E-for-ArrayString%3CCAP%3E">PartialEq<ArrayString<CAP>></a></li><li><a href="#impl-PartialEq%3CArrayString%3CCAP%3E%3E-for-str">PartialEq<ArrayString<CAP>></a></li><li><a href="#impl-PartialEq%3Cstr%3E-for-ArrayString%3CCAP%3E">PartialEq<str></a></li><li><a href="#impl-PartialOrd%3CArrayString%3CCAP%3E%3E-for-ArrayString%3CCAP%3E">PartialOrd<ArrayString<CAP>></a></li><li><a href="#impl-PartialOrd%3CArrayString%3CCAP%3E%3E-for-str">PartialOrd<ArrayString<CAP>></a></li><li><a href="#impl-PartialOrd%3Cstr%3E-for-ArrayString%3CCAP%3E">PartialOrd<str></a></li><li><a href="#impl-TryFrom%3C%26%27a%20str%3E-for-ArrayString%3CCAP%3E">TryFrom<&'a str></a></li><li><a href="#impl-TryFrom%3CArguments%3C%27a%3E%3E-for-ArrayString%3CCAP%3E">TryFrom<Arguments<'a>></a></li><li><a href="#impl-Write-for-ArrayString%3CCAP%3E">Write</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-ArrayString%3CCAP%3E">RefUnwindSafe</a></li><li><a href="#impl-Send-for-ArrayString%3CCAP%3E">Send</a></li><li><a href="#impl-Sync-for-ArrayString%3CCAP%3E">Sync</a></li><li><a href="#impl-Unpin-for-ArrayString%3CCAP%3E">Unpin</a></li><li><a href="#impl-UnwindSafe-for-ArrayString%3CCAP%3E">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-ArrayString%3CCAP%3E">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-ArrayString%3CCAP%3E">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-ArrayString%3CCAP%3E">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-ArrayString%3CCAP%3E">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-ArrayString%3CCAP%3E">Into<U></a></li><li><a href="#impl-ToOwned-for-ArrayString%3CCAP%3E">ToOwned</a></li><li><a href="#impl-ToString-for-ArrayString%3CCAP%3E">ToString</a></li><li><a href="#impl-TryFrom%3CU%3E-for-ArrayString%3CCAP%3E">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-ArrayString%3CCAP%3E">TryInto<U></a></li></ul></section><h2><a href="index.html">In arrayvec</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press โSโ to search, โ?โ for more optionsโฆ" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Struct <a href="index.html">arrayvec</a>::<wbr><a class="struct" href="#">ArrayString</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../src/arrayvec/array_string.rs.html#34-38">source</a> ยท <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="item-decl"><pre class="rust struct"><code>pub struct ArrayString<const CAP: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>> { /* private fields */ }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A string with a fixed capacity.</p>
|
||
<p>The <code>ArrayString</code> is a string backed by a fixed size array. It keeps track
|
||
of its length, and is parameterized by <code>CAP</code> for the maximum capacity.</p>
|
||
<p><code>CAP</code> is of type <code>usize</code> but is range limited to <code>u32::MAX</code>; attempting to create larger
|
||
arrayvecs with larger capacity will panic.</p>
|
||
<p>The string is a contiguous value that you can store directly on the stack
|
||
if needed.</p>
|
||
</div></details><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><div id="implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-ArrayString%3CCAP%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#48-420">source</a><a href="#impl-ArrayString%3CCAP%3E" class="anchor"></a><h3 class="code-header">impl<const CAP: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>> <a class="struct" href="struct.ArrayString.html" title="struct arrayvec::ArrayString">ArrayString</a><CAP></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.new" class="method has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#62-67">source</a><h4 class="code-header">pub fn <a href="#method.new" class="fnname">new</a>() -> <a class="struct" href="struct.ArrayString.html" title="struct arrayvec::ArrayString">ArrayString</a><CAP></h4></section></summary><div class="docblock"><p>Create a new empty <code>ArrayString</code>.</p>
|
||
<p>Capacity is inferred from the type parameter.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>arrayvec::ArrayString;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>string = ArrayString::<<span class="number">16</span>>::new();
|
||
string.push_str(<span class="string">"foo"</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="kw-2">&</span>string[..], <span class="string">"foo"</span>);
|
||
<span class="macro">assert_eq!</span>(string.capacity(), <span class="number">16</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.new_const" class="method has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#78-81">source</a><h4 class="code-header">pub const fn <a href="#method.new_const" class="fnname">new_const</a>() -> <a class="struct" href="struct.ArrayString.html" title="struct arrayvec::ArrayString">ArrayString</a><CAP></h4></section></summary><div class="docblock"><p>Create a new empty <code>ArrayString</code> (const fn).</p>
|
||
<p>Capacity is inferred from the type parameter.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>arrayvec::ArrayString;
|
||
|
||
<span class="kw">static </span>ARRAY: ArrayString<<span class="number">1024</span>> = ArrayString::new_const();</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.len" class="method has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#85">source</a><h4 class="code-header">pub const fn <a href="#method.len" class="fnname">len</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>Return the length of the string.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.is_empty" class="method has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#89">source</a><h4 class="code-header">pub const fn <a href="#method.is_empty" class="fnname">is_empty</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns whether the string is empty.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from" class="method has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#105-109">source</a><h4 class="code-header">pub fn <a href="#method.from" class="fnname">from</a>(s: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, <a class="struct" href="struct.CapacityError.html" title="struct arrayvec::CapacityError">CapacityError</a><&<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>></h4></section></summary><div class="docblock"><p>Create a new <code>ArrayString</code> from a <code>str</code>.</p>
|
||
<p>Capacity is inferred from the type parameter.</p>
|
||
<p><strong>Errors</strong> if the backing array is not large enough to fit the string.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>arrayvec::ArrayString;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>string = ArrayString::<<span class="number">3</span>>::from(<span class="string">"foo"</span>).unwrap();
|
||
<span class="macro">assert_eq!</span>(<span class="kw-2">&</span>string[..], <span class="string">"foo"</span>);
|
||
<span class="macro">assert_eq!</span>(string.len(), <span class="number">3</span>);
|
||
<span class="macro">assert_eq!</span>(string.capacity(), <span class="number">3</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from_byte_string" class="method has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#120-130">source</a><h4 class="code-header">pub fn <a href="#method.from_byte_string" class="fnname">from_byte_string</a>(b: &[<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">CAP</a>]) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, <a class="struct" href="https://doc.rust-lang.org/nightly/core/str/error/struct.Utf8Error.html" title="struct core::str::error::Utf8Error">Utf8Error</a>></h4></section></summary><div class="docblock"><p>Create a new <code>ArrayString</code> from a byte string literal.</p>
|
||
<p><strong>Errors</strong> if the byte string literal is not valid UTF-8.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>arrayvec::ArrayString;
|
||
|
||
<span class="kw">let </span>string = ArrayString::from_byte_string(<span class="string">b"hello world"</span>).unwrap();</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.zero_filled" class="method has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#142-152">source</a><h4 class="code-header">pub fn <a href="#method.zero_filled" class="fnname">zero_filled</a>() -> Self</h4></section></summary><div class="docblock"><p>Create a new <code>ArrayString</code> value fully filled with ASCII NULL characters (<code>\0</code>). Useful
|
||
to be used as a buffer to collect external data or as a buffer for intermediate processing.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>arrayvec::ArrayString;
|
||
|
||
<span class="kw">let </span>string = ArrayString::<<span class="number">16</span>>::zero_filled();
|
||
<span class="macro">assert_eq!</span>(string.len(), <span class="number">16</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.capacity" class="method has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#163">source</a><h4 class="code-header">pub const fn <a href="#method.capacity" class="fnname">capacity</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>Return the capacity of the <code>ArrayString</code>.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>arrayvec::ArrayString;
|
||
|
||
<span class="kw">let </span>string = ArrayString::<<span class="number">3</span>>::new();
|
||
<span class="macro">assert_eq!</span>(string.capacity(), <span class="number">3</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.is_full" class="method has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#175">source</a><h4 class="code-header">pub const fn <a href="#method.is_full" class="fnname">is_full</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Return if the <code>ArrayString</code> is completely filled.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>arrayvec::ArrayString;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>string = ArrayString::<<span class="number">1</span>>::new();
|
||
<span class="macro">assert!</span>(!string.is_full());
|
||
string.push_str(<span class="string">"A"</span>);
|
||
<span class="macro">assert!</span>(string.is_full());</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.remaining_capacity" class="method has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#186-188">source</a><h4 class="code-header">pub const fn <a href="#method.remaining_capacity" class="fnname">remaining_capacity</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>Returns the capacity left in the <code>ArrayString</code>.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>arrayvec::ArrayString;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>string = ArrayString::<<span class="number">3</span>>::from(<span class="string">"abc"</span>).unwrap();
|
||
string.pop();
|
||
<span class="macro">assert_eq!</span>(string.remaining_capacity(), <span class="number">1</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.push" class="method has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#204-206">source</a><h4 class="code-header">pub fn <a href="#method.push" class="fnname">push</a>(&mut self, c: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.char.html">char</a>)</h4></section></summary><div class="docblock"><p>Adds the given char to the end of the string.</p>
|
||
<p><em><strong>Panics</strong></em> if the backing array is not large enough to fit the additional char.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>arrayvec::ArrayString;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>string = ArrayString::<<span class="number">2</span>>::new();
|
||
|
||
string.push(<span class="string">'a'</span>);
|
||
string.push(<span class="string">'b'</span>);
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="kw-2">&</span>string[..], <span class="string">"ab"</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_push" class="method has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#226-239">source</a><h4 class="code-header">pub fn <a href="#method.try_push" class="fnname">try_push</a>(&mut self, c: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.char.html">char</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="struct.CapacityError.html" title="struct arrayvec::CapacityError">CapacityError</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.char.html">char</a>>></h4></section></summary><div class="docblock"><p>Adds the given char to the end of the string.</p>
|
||
<p>Returns <code>Ok</code> if the push succeeds.</p>
|
||
<p><strong>Errors</strong> if the backing array is not large enough to fit the additional char.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>arrayvec::ArrayString;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>string = ArrayString::<<span class="number">2</span>>::new();
|
||
|
||
string.try_push(<span class="string">'a'</span>).unwrap();
|
||
string.try_push(<span class="string">'b'</span>).unwrap();
|
||
<span class="kw">let </span>overflow = string.try_push(<span class="string">'c'</span>);
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="kw-2">&</span>string[..], <span class="string">"ab"</span>);
|
||
<span class="macro">assert_eq!</span>(overflow.unwrap_err().element(), <span class="string">'c'</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.push_str" class="method has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#255-257">source</a><h4 class="code-header">pub fn <a href="#method.push_str" class="fnname">push_str</a>(&mut self, s: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>)</h4></section></summary><div class="docblock"><p>Adds the given string slice to the end of the string.</p>
|
||
<p><em><strong>Panics</strong></em> if the backing array is not large enough to fit the string.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>arrayvec::ArrayString;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>string = ArrayString::<<span class="number">2</span>>::new();
|
||
|
||
string.push_str(<span class="string">"a"</span>);
|
||
string.push_str(<span class="string">"d"</span>);
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="kw-2">&</span>string[..], <span class="string">"ad"</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_push_str" class="method has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#279-291">source</a><h4 class="code-header">pub fn <a href="#method.try_push_str" class="fnname">try_push_str</a><'a>(<br> &mut self,<br> s: &'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="struct.CapacityError.html" title="struct arrayvec::CapacityError">CapacityError</a><&'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>></h4></section></summary><div class="docblock"><p>Adds the given string slice to the end of the string.</p>
|
||
<p>Returns <code>Ok</code> if the push succeeds.</p>
|
||
<p><strong>Errors</strong> if the backing array is not large enough to fit the string.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>arrayvec::ArrayString;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>string = ArrayString::<<span class="number">2</span>>::new();
|
||
|
||
string.try_push_str(<span class="string">"a"</span>).unwrap();
|
||
<span class="kw">let </span>overflow1 = string.try_push_str(<span class="string">"bc"</span>);
|
||
string.try_push_str(<span class="string">"d"</span>).unwrap();
|
||
<span class="kw">let </span>overflow2 = string.try_push_str(<span class="string">"ef"</span>);
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="kw-2">&</span>string[..], <span class="string">"ad"</span>);
|
||
<span class="macro">assert_eq!</span>(overflow1.unwrap_err().element(), <span class="string">"bc"</span>);
|
||
<span class="macro">assert_eq!</span>(overflow2.unwrap_err().element(), <span class="string">"ef"</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.pop" class="method has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#308-318">source</a><h4 class="code-header">pub fn <a href="#method.pop" class="fnname">pop</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.char.html">char</a>></h4></section></summary><div class="docblock"><p>Removes the last character from the string and returns it.</p>
|
||
<p>Returns <code>None</code> if this <code>ArrayString</code> is empty.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>arrayvec::ArrayString;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>s = ArrayString::<<span class="number">3</span>>::from(<span class="string">"foo"</span>).unwrap();
|
||
|
||
<span class="macro">assert_eq!</span>(s.pop(), <span class="prelude-val">Some</span>(<span class="string">'o'</span>));
|
||
<span class="macro">assert_eq!</span>(s.pop(), <span class="prelude-val">Some</span>(<span class="string">'o'</span>));
|
||
<span class="macro">assert_eq!</span>(s.pop(), <span class="prelude-val">Some</span>(<span class="string">'f'</span>));
|
||
|
||
<span class="macro">assert_eq!</span>(s.pop(), <span class="prelude-val">None</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.truncate" class="method has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#336-347">source</a><h4 class="code-header">pub fn <a href="#method.truncate" class="fnname">truncate</a>(&mut self, new_len: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>)</h4></section></summary><div class="docblock"><p>Shortens this <code>ArrayString</code> to the specified length.</p>
|
||
<p>If <code>new_len</code> is greater than the stringโs current length, this has no
|
||
effect.</p>
|
||
<p><em><strong>Panics</strong></em> if <code>new_len</code> does not lie on a <code>char</code> boundary.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>arrayvec::ArrayString;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>string = ArrayString::<<span class="number">6</span>>::from(<span class="string">"foobar"</span>).unwrap();
|
||
string.truncate(<span class="number">3</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="kw-2">&</span>string[..], <span class="string">"foo"</span>);
|
||
string.truncate(<span class="number">4</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="kw-2">&</span>string[..], <span class="string">"foo"</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.remove" class="method has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#366-381">source</a><h4 class="code-header">pub fn <a href="#method.remove" class="fnname">remove</a>(&mut self, idx: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.char.html">char</a></h4></section></summary><div class="docblock"><p>Removes a <code>char</code> from this <code>ArrayString</code> at a byte position and returns it.</p>
|
||
<p>This is an <code>O(n)</code> operation, as it requires copying every element in the
|
||
array.</p>
|
||
<p><em><strong>Panics</strong></em> if <code>idx</code> is larger than or equal to the <code>ArrayString</code>โs length,
|
||
or if it does not lie on a <code>char</code> boundary.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>arrayvec::ArrayString;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>s = ArrayString::<<span class="number">3</span>>::from(<span class="string">"foo"</span>).unwrap();
|
||
|
||
<span class="macro">assert_eq!</span>(s.remove(<span class="number">0</span>), <span class="string">'f'</span>);
|
||
<span class="macro">assert_eq!</span>(s.remove(<span class="number">1</span>), <span class="string">'o'</span>);
|
||
<span class="macro">assert_eq!</span>(s.remove(<span class="number">0</span>), <span class="string">'o'</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clear" class="method has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#384-388">source</a><h4 class="code-header">pub fn <a href="#method.clear" class="fnname">clear</a>(&mut self)</h4></section></summary><div class="docblock"><p>Make the string empty.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.set_len" class="method has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#397-401">source</a><h4 class="code-header">pub unsafe fn <a href="#method.set_len" class="fnname">set_len</a>(&mut self, length: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>)</h4></section></summary><div class="docblock"><p>Set the stringsโs length.</p>
|
||
<p>This function is <code>unsafe</code> because it changes the notion of the
|
||
number of โvalidโ bytes in the string. Use with care.</p>
|
||
<p>This method uses <em>debug assertions</em> to check the validity of <code>length</code>
|
||
and may use other debug assertions.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.as_str" class="method has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#404-406">source</a><h4 class="code-header">pub fn <a href="#method.as_str" class="fnname">as_str</a>(&self) -> &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a></h4></section></summary><div class="docblock"><p>Return a string slice of the whole <code>ArrayString</code>.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.as_mut_str" class="method has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#409-411">source</a><h4 class="code-header">pub fn <a href="#method.as_mut_str" class="fnname">as_mut_str</a>(&mut self) -> &mut <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a></h4></section></summary><div class="docblock"><p>Return a mutable string slice of the whole <code>ArrayString</code>.</p>
|
||
</div></details></div></details></div><h2 id="deref-methods-str" class="small-section-header"><span>Methods from <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a><Target = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>></span><a href="#deref-methods-str" class="anchor"></a></h2><div id="deref-methods-str-1"><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.len-1" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#159">source</a></span><h4 class="code-header">pub fn <a href="#method.len-1" class="fnname">len</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>Returns the length of <code>self</code>.</p>
|
||
<p>This length is in bytes, not <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a>s or graphemes. In other words,
|
||
it might not be what a human considers the length of the string.</p>
|
||
<h5 id="examples"><a href="#examples">Examples</a></h5>
|
||
<p>Basic usage:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>len = <span class="string">"foo"</span>.len();
|
||
<span class="macro">assert_eq!</span>(<span class="number">3</span>, len);
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="string">"ฦoo"</span>.len(), <span class="number">4</span>); <span class="comment">// fancy f!
|
||
</span><span class="macro">assert_eq!</span>(<span class="string">"ฦoo"</span>.chars().count(), <span class="number">3</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.is_empty-1" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#180">source</a></span><h4 class="code-header">pub fn <a href="#method.is_empty-1" class="fnname">is_empty</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns <code>true</code> if <code>self</code> has a length of zero bytes.</p>
|
||
<h5 id="examples-1"><a href="#examples-1">Examples</a></h5>
|
||
<p>Basic usage:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>s = <span class="string">""</span>;
|
||
<span class="macro">assert!</span>(s.is_empty());
|
||
|
||
<span class="kw">let </span>s = <span class="string">"not empty"</span>;
|
||
<span class="macro">assert!</span>(!s.is_empty());</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.is_char_boundary" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.9.0">1.9.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#211">source</a></span><h4 class="code-header">pub fn <a href="#method.is_char_boundary" class="fnname">is_char_boundary</a>(&self, index: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Checks that <code>index</code>-th byte is the first byte in a UTF-8 code point
|
||
sequence or the end of the string.</p>
|
||
<p>The start and end of the string (when <code>index == self.len()</code>) are
|
||
considered to be boundaries.</p>
|
||
<p>Returns <code>false</code> if <code>index</code> is greater than <code>self.len()</code>.</p>
|
||
<h5 id="examples-2"><a href="#examples-2">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>s = <span class="string">"Lรถwe ่่ Lรฉopard"</span>;
|
||
<span class="macro">assert!</span>(s.is_char_boundary(<span class="number">0</span>));
|
||
<span class="comment">// start of `่`
|
||
</span><span class="macro">assert!</span>(s.is_char_boundary(<span class="number">6</span>));
|
||
<span class="macro">assert!</span>(s.is_char_boundary(s.len()));
|
||
|
||
<span class="comment">// second byte of `รถ`
|
||
</span><span class="macro">assert!</span>(!s.is_char_boundary(<span class="number">2</span>));
|
||
|
||
<span class="comment">// third byte of `่`
|
||
</span><span class="macro">assert!</span>(!s.is_char_boundary(<span class="number">8</span>));</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.floor_char_boundary" class="method has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#258">source</a><h4 class="code-header">pub fn <a href="#method.floor_char_boundary" class="fnname">floor_char_boundary</a>(&self, index: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">๐ฌ</span><span>This is a nightly-only experimental API. (<code>round_char_boundary</code>)</span></div></span></summary><div class="docblock"><p>Finds the closest <code>x</code> not exceeding <code>index</code> where <code>is_char_boundary(x)</code> is <code>true</code>.</p>
|
||
<p>This method can help you truncate a string so that itโs still valid UTF-8, but doesnโt
|
||
exceed a given number of bytes. Note that this is done purely at the character level
|
||
and can still visually split graphemes, even though the underlying characters arenโt
|
||
split. For example, the emoji ๐งโ๐ฌ (scientist) could be split so that the string only
|
||
includes ๐ง (person) instead.</p>
|
||
<h5 id="examples-3"><a href="#examples-3">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attribute">#![feature(round_char_boundary)]
|
||
</span><span class="kw">let </span>s = <span class="string">"โค๏ธ๐งก๐๐๐๐"</span>;
|
||
<span class="macro">assert_eq!</span>(s.len(), <span class="number">26</span>);
|
||
<span class="macro">assert!</span>(!s.is_char_boundary(<span class="number">13</span>));
|
||
|
||
<span class="kw">let </span>closest = s.floor_char_boundary(<span class="number">13</span>);
|
||
<span class="macro">assert_eq!</span>(closest, <span class="number">10</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="kw-2">&</span>s[..closest], <span class="string">"โค๏ธ๐งก"</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.ceil_char_boundary" class="method has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#297">source</a><h4 class="code-header">pub fn <a href="#method.ceil_char_boundary" class="fnname">ceil_char_boundary</a>(&self, index: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">๐ฌ</span><span>This is a nightly-only experimental API. (<code>round_char_boundary</code>)</span></div></span></summary><div class="docblock"><p>Finds the closest <code>x</code> not below <code>index</code> where <code>is_char_boundary(x)</code> is <code>true</code>.</p>
|
||
<p>This method is the natural complement to <a href="https://doc.rust-lang.org/nightly/std/primitive.str.html#method.floor_char_boundary"><code>floor_char_boundary</code></a>. See that method
|
||
for more details.</p>
|
||
<h5 id="panics"><a href="#panics">Panics</a></h5>
|
||
<p>Panics if <code>index > self.len()</code>.</p>
|
||
<h5 id="examples-4"><a href="#examples-4">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attribute">#![feature(round_char_boundary)]
|
||
</span><span class="kw">let </span>s = <span class="string">"โค๏ธ๐งก๐๐๐๐"</span>;
|
||
<span class="macro">assert_eq!</span>(s.len(), <span class="number">26</span>);
|
||
<span class="macro">assert!</span>(!s.is_char_boundary(<span class="number">13</span>));
|
||
|
||
<span class="kw">let </span>closest = s.ceil_char_boundary(<span class="number">13</span>);
|
||
<span class="macro">assert_eq!</span>(closest, <span class="number">14</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="kw-2">&</span>s[..closest], <span class="string">"โค๏ธ๐งก๐"</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.as_bytes" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#325">source</a></span><h4 class="code-header">pub fn <a href="#method.as_bytes" class="fnname">as_bytes</a>(&self) -> &[<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>]<span class="notable-traits"><span class="notable-traits-tooltip">โ<span class="notable-traits-tooltiptext"><span class="docblock"><span class="notable">Notable traits for &mut [<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>]</span><code class="content"><span class="where fmt-newline">impl <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> for &mut [<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>]</span><span class="where fmt-newline">impl <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> for &[<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>]</span></code></span></span></span></span></h4></section></summary><div class="docblock"><p>Converts a string slice to a byte slice. To convert the byte slice back
|
||
into a string slice, use the <a href="https://doc.rust-lang.org/nightly/core/str/converts/fn.from_utf8.html" title="from_utf8"><code>from_utf8</code></a> function.</p>
|
||
<h5 id="examples-5"><a href="#examples-5">Examples</a></h5>
|
||
<p>Basic usage:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>bytes = <span class="string">"bors"</span>.as_bytes();
|
||
<span class="macro">assert_eq!</span>(<span class="string">b"bors"</span>, bytes);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.as_bytes_mut" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.20.0">1.20.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#369">source</a></span><h4 class="code-header">pub unsafe fn <a href="#method.as_bytes_mut" class="fnname">as_bytes_mut</a>(&mut self) -> &mut [<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>]<span class="notable-traits"><span class="notable-traits-tooltip">โ<span class="notable-traits-tooltiptext"><span class="docblock"><span class="notable">Notable traits for &mut [<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>]</span><code class="content"><span class="where fmt-newline">impl <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> for &mut [<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>]</span><span class="where fmt-newline">impl <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> for &[<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>]</span></code></span></span></span></span></h4></section></summary><div class="docblock"><p>Converts a mutable string slice to a mutable byte slice.</p>
|
||
<h5 id="safety"><a href="#safety">Safety</a></h5>
|
||
<p>The caller must ensure that the content of the slice is valid UTF-8
|
||
before the borrow ends and the underlying <code>str</code> is used.</p>
|
||
<p>Use of a <code>str</code> whose contents are not valid UTF-8 is undefined behavior.</p>
|
||
<h5 id="examples-6"><a href="#examples-6">Examples</a></h5>
|
||
<p>Basic usage:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>s = String::from(<span class="string">"Hello"</span>);
|
||
<span class="kw">let </span>bytes = <span class="kw">unsafe </span>{ s.as_bytes_mut() };
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="string">b"Hello"</span>, bytes);</code></pre></div>
|
||
<p>Mutability:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>s = String::from(<span class="string">"๐ปโ๐"</span>);
|
||
|
||
<span class="kw">unsafe </span>{
|
||
<span class="kw">let </span>bytes = s.as_bytes_mut();
|
||
|
||
bytes[<span class="number">0</span>] = <span class="number">0xF0</span>;
|
||
bytes[<span class="number">1</span>] = <span class="number">0x9F</span>;
|
||
bytes[<span class="number">2</span>] = <span class="number">0x8D</span>;
|
||
bytes[<span class="number">3</span>] = <span class="number">0x94</span>;
|
||
}
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="string">"๐โ๐"</span>, s);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.as_ptr" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#400">source</a></span><h4 class="code-header">pub fn <a href="#method.as_ptr" class="fnname">as_ptr</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*const </a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a></h4></section></summary><div class="docblock"><p>Converts a string slice to a raw pointer.</p>
|
||
<p>As string slices are a slice of bytes, the raw pointer points to a
|
||
<a href="https://doc.rust-lang.org/nightly/std/primitive.u8.html" title="u8"><code>u8</code></a>. This pointer will be pointing to the first byte of the string
|
||
slice.</p>
|
||
<p>The caller must ensure that the returned pointer is never written to.
|
||
If you need to mutate the contents of the string slice, use <a href="https://doc.rust-lang.org/nightly/std/primitive.str.html#method.as_mut_ptr"><code>as_mut_ptr</code></a>.</p>
|
||
<h5 id="examples-7"><a href="#examples-7">Examples</a></h5>
|
||
<p>Basic usage:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>s = <span class="string">"Hello"</span>;
|
||
<span class="kw">let </span>ptr = s.as_ptr();</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.as_mut_ptr" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.36.0">1.36.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#415">source</a></span><h4 class="code-header">pub fn <a href="#method.as_mut_ptr" class="fnname">as_mut_ptr</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a></h4></section></summary><div class="docblock"><p>Converts a mutable string slice to a raw pointer.</p>
|
||
<p>As string slices are a slice of bytes, the raw pointer points to a
|
||
<a href="https://doc.rust-lang.org/nightly/std/primitive.u8.html" title="u8"><code>u8</code></a>. This pointer will be pointing to the first byte of the string
|
||
slice.</p>
|
||
<p>It is your responsibility to make sure that the string slice only gets
|
||
modified in a way that it remains valid UTF-8.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.get" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.20.0">1.20.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#441">source</a></span><h4 class="code-header">pub fn <a href="#method.get" class="fnname">get</a><I>(&self, i: I) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<I as <a class="trait" href="https://doc.rust-lang.org/nightly/core/slice/index/trait.SliceIndex.html" title="trait core::slice::index::SliceIndex">SliceIndex</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/slice/index/trait.SliceIndex.html#associatedtype.Output" title="type core::slice::index::SliceIndex::Output">Output</a>><span class="where fmt-newline">where<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/slice/index/trait.SliceIndex.html" title="trait core::slice::index::SliceIndex">SliceIndex</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>,</span></h4></section></summary><div class="docblock"><p>Returns a subslice of <code>str</code>.</p>
|
||
<p>This is the non-panicking alternative to indexing the <code>str</code>. Returns
|
||
<a href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html#variant.None" title="None"><code>None</code></a> whenever equivalent indexing operation would panic.</p>
|
||
<h5 id="examples-8"><a href="#examples-8">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>v = String::from(<span class="string">"๐ปโ๐"</span>);
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(<span class="string">"๐ป"</span>), v.get(<span class="number">0</span>..<span class="number">4</span>));
|
||
|
||
<span class="comment">// indices not on UTF-8 sequence boundaries
|
||
</span><span class="macro">assert!</span>(v.get(<span class="number">1</span>..).is_none());
|
||
<span class="macro">assert!</span>(v.get(..<span class="number">8</span>).is_none());
|
||
|
||
<span class="comment">// out of bounds
|
||
</span><span class="macro">assert!</span>(v.get(..<span class="number">42</span>).is_none());</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.get_mut" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.20.0">1.20.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#474">source</a></span><h4 class="code-header">pub fn <a href="#method.get_mut" class="fnname">get_mut</a><I>(&mut self, i: I) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&mut <I as <a class="trait" href="https://doc.rust-lang.org/nightly/core/slice/index/trait.SliceIndex.html" title="trait core::slice::index::SliceIndex">SliceIndex</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/slice/index/trait.SliceIndex.html#associatedtype.Output" title="type core::slice::index::SliceIndex::Output">Output</a>><span class="where fmt-newline">where<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/slice/index/trait.SliceIndex.html" title="trait core::slice::index::SliceIndex">SliceIndex</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>,</span></h4></section></summary><div class="docblock"><p>Returns a mutable subslice of <code>str</code>.</p>
|
||
<p>This is the non-panicking alternative to indexing the <code>str</code>. Returns
|
||
<a href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html#variant.None" title="None"><code>None</code></a> whenever equivalent indexing operation would panic.</p>
|
||
<h5 id="examples-9"><a href="#examples-9">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>v = String::from(<span class="string">"hello"</span>);
|
||
<span class="comment">// correct length
|
||
</span><span class="macro">assert!</span>(v.get_mut(<span class="number">0</span>..<span class="number">5</span>).is_some());
|
||
<span class="comment">// out of bounds
|
||
</span><span class="macro">assert!</span>(v.get_mut(..<span class="number">42</span>).is_none());
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(<span class="string">"he"</span>), v.get_mut(<span class="number">0</span>..<span class="number">2</span>).map(|v| <span class="kw-2">&*</span>v));
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="string">"hello"</span>, v);
|
||
{
|
||
<span class="kw">let </span>s = v.get_mut(<span class="number">0</span>..<span class="number">2</span>);
|
||
<span class="kw">let </span>s = s.map(|s| {
|
||
s.make_ascii_uppercase();
|
||
<span class="kw-2">&*</span>s
|
||
});
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(<span class="string">"HE"</span>), s);
|
||
}
|
||
<span class="macro">assert_eq!</span>(<span class="string">"HEllo"</span>, v);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.get_unchecked" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.20.0">1.20.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#507">source</a></span><h4 class="code-header">pub unsafe fn <a href="#method.get_unchecked" class="fnname">get_unchecked</a><I>(&self, i: I) -> &<I as <a class="trait" href="https://doc.rust-lang.org/nightly/core/slice/index/trait.SliceIndex.html" title="trait core::slice::index::SliceIndex">SliceIndex</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/slice/index/trait.SliceIndex.html#associatedtype.Output" title="type core::slice::index::SliceIndex::Output">Output</a><span class="where fmt-newline">where<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/slice/index/trait.SliceIndex.html" title="trait core::slice::index::SliceIndex">SliceIndex</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>,</span></h4></section></summary><div class="docblock"><p>Returns an unchecked subslice of <code>str</code>.</p>
|
||
<p>This is the unchecked alternative to indexing the <code>str</code>.</p>
|
||
<h5 id="safety-1"><a href="#safety-1">Safety</a></h5>
|
||
<p>Callers of this function are responsible that these preconditions are
|
||
satisfied:</p>
|
||
<ul>
|
||
<li>The starting index must not exceed the ending index;</li>
|
||
<li>Indexes must be within bounds of the original slice;</li>
|
||
<li>Indexes must lie on UTF-8 sequence boundaries.</li>
|
||
</ul>
|
||
<p>Failing that, the returned string slice may reference invalid memory or
|
||
violate the invariants communicated by the <code>str</code> type.</p>
|
||
<h5 id="examples-10"><a href="#examples-10">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>v = <span class="string">"๐ปโ๐"</span>;
|
||
<span class="kw">unsafe </span>{
|
||
<span class="macro">assert_eq!</span>(<span class="string">"๐ป"</span>, v.get_unchecked(<span class="number">0</span>..<span class="number">4</span>));
|
||
<span class="macro">assert_eq!</span>(<span class="string">"โ"</span>, v.get_unchecked(<span class="number">4</span>..<span class="number">7</span>));
|
||
<span class="macro">assert_eq!</span>(<span class="string">"๐"</span>, v.get_unchecked(<span class="number">7</span>..<span class="number">11</span>));
|
||
}</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.get_unchecked_mut" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.20.0">1.20.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#543-546">source</a></span><h4 class="code-header">pub unsafe fn <a href="#method.get_unchecked_mut" class="fnname">get_unchecked_mut</a><I>(<br> &mut self,<br> i: I<br>) -> &mut <I as <a class="trait" href="https://doc.rust-lang.org/nightly/core/slice/index/trait.SliceIndex.html" title="trait core::slice::index::SliceIndex">SliceIndex</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/slice/index/trait.SliceIndex.html#associatedtype.Output" title="type core::slice::index::SliceIndex::Output">Output</a><span class="where fmt-newline">where<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/slice/index/trait.SliceIndex.html" title="trait core::slice::index::SliceIndex">SliceIndex</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>,</span></h4></section></summary><div class="docblock"><p>Returns a mutable, unchecked subslice of <code>str</code>.</p>
|
||
<p>This is the unchecked alternative to indexing the <code>str</code>.</p>
|
||
<h5 id="safety-2"><a href="#safety-2">Safety</a></h5>
|
||
<p>Callers of this function are responsible that these preconditions are
|
||
satisfied:</p>
|
||
<ul>
|
||
<li>The starting index must not exceed the ending index;</li>
|
||
<li>Indexes must be within bounds of the original slice;</li>
|
||
<li>Indexes must lie on UTF-8 sequence boundaries.</li>
|
||
</ul>
|
||
<p>Failing that, the returned string slice may reference invalid memory or
|
||
violate the invariants communicated by the <code>str</code> type.</p>
|
||
<h5 id="examples-11"><a href="#examples-11">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>v = String::from(<span class="string">"๐ปโ๐"</span>);
|
||
<span class="kw">unsafe </span>{
|
||
<span class="macro">assert_eq!</span>(<span class="string">"๐ป"</span>, v.get_unchecked_mut(<span class="number">0</span>..<span class="number">4</span>));
|
||
<span class="macro">assert_eq!</span>(<span class="string">"โ"</span>, v.get_unchecked_mut(<span class="number">4</span>..<span class="number">7</span>));
|
||
<span class="macro">assert_eq!</span>(<span class="string">"๐"</span>, v.get_unchecked_mut(<span class="number">7</span>..<span class="number">11</span>));
|
||
}</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.slice_unchecked" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#599">source</a></span><h4 class="code-header">pub unsafe fn <a href="#method.slice_unchecked" class="fnname">slice_unchecked</a>(&self, begin: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, end: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a></h4></section><span class="item-info"><div class="stab deprecated"><span class="emoji">๐</span><span>Deprecated since 1.29.0: use <code>get_unchecked(begin..end)</code> instead</span></div></span></summary><div class="docblock"><p>Creates a string slice from another string slice, bypassing safety
|
||
checks.</p>
|
||
<p>This is generally not recommended, use with caution! For a safe
|
||
alternative see <a href="https://doc.rust-lang.org/nightly/std/primitive.str.html" title="str"><code>str</code></a> and <a href="https://doc.rust-lang.org/nightly/core/ops/index/trait.Index.html"><code>Index</code></a>.</p>
|
||
<p>This new slice goes from <code>begin</code> to <code>end</code>, including <code>begin</code> but
|
||
excluding <code>end</code>.</p>
|
||
<p>To get a mutable string slice instead, see the
|
||
<a href="https://doc.rust-lang.org/nightly/std/primitive.str.html#method.slice_mut_unchecked"><code>slice_mut_unchecked</code></a> method.</p>
|
||
<h5 id="safety-3"><a href="#safety-3">Safety</a></h5>
|
||
<p>Callers of this function are responsible that three preconditions are
|
||
satisfied:</p>
|
||
<ul>
|
||
<li><code>begin</code> must not exceed <code>end</code>.</li>
|
||
<li><code>begin</code> and <code>end</code> must be byte positions within the string slice.</li>
|
||
<li><code>begin</code> and <code>end</code> must lie on UTF-8 sequence boundaries.</li>
|
||
</ul>
|
||
<h5 id="examples-12"><a href="#examples-12">Examples</a></h5>
|
||
<p>Basic usage:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>s = <span class="string">"Lรถwe ่่ Lรฉopard"</span>;
|
||
|
||
<span class="kw">unsafe </span>{
|
||
<span class="macro">assert_eq!</span>(<span class="string">"Lรถwe ่่ Lรฉopard"</span>, s.slice_unchecked(<span class="number">0</span>, <span class="number">21</span>));
|
||
}
|
||
|
||
<span class="kw">let </span>s = <span class="string">"Hello, world!"</span>;
|
||
|
||
<span class="kw">unsafe </span>{
|
||
<span class="macro">assert_eq!</span>(<span class="string">"world"</span>, s.slice_unchecked(<span class="number">7</span>, <span class="number">12</span>));
|
||
}</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.slice_mut_unchecked" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.5.0">1.5.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#632">source</a></span><h4 class="code-header">pub unsafe fn <a href="#method.slice_mut_unchecked" class="fnname">slice_mut_unchecked</a>(&mut self, begin: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, end: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> &mut <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a></h4></section><span class="item-info"><div class="stab deprecated"><span class="emoji">๐</span><span>Deprecated since 1.29.0: use <code>get_unchecked_mut(begin..end)</code> instead</span></div></span></summary><div class="docblock"><p>Creates a string slice from another string slice, bypassing safety
|
||
checks.
|
||
This is generally not recommended, use with caution! For a safe
|
||
alternative see <a href="https://doc.rust-lang.org/nightly/std/primitive.str.html" title="str"><code>str</code></a> and <a href="https://doc.rust-lang.org/nightly/core/ops/index/trait.IndexMut.html"><code>IndexMut</code></a>.</p>
|
||
<p>This new slice goes from <code>begin</code> to <code>end</code>, including <code>begin</code> but
|
||
excluding <code>end</code>.</p>
|
||
<p>To get an immutable string slice instead, see the
|
||
<a href="https://doc.rust-lang.org/nightly/std/primitive.str.html#method.slice_unchecked"><code>slice_unchecked</code></a> method.</p>
|
||
<h5 id="safety-4"><a href="#safety-4">Safety</a></h5>
|
||
<p>Callers of this function are responsible that three preconditions are
|
||
satisfied:</p>
|
||
<ul>
|
||
<li><code>begin</code> must not exceed <code>end</code>.</li>
|
||
<li><code>begin</code> and <code>end</code> must be byte positions within the string slice.</li>
|
||
<li><code>begin</code> and <code>end</code> must lie on UTF-8 sequence boundaries.</li>
|
||
</ul>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.split_at" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.4.0">1.4.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#672">source</a></span><h4 class="code-header">pub fn <a href="#method.split_at" class="fnname">split_at</a>(&self, mid: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> (&<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>)</h4></section></summary><div class="docblock"><p>Divide one string slice into two at an index.</p>
|
||
<p>The argument, <code>mid</code>, should be a byte offset from the start of the
|
||
string. It must also be on the boundary of a UTF-8 code point.</p>
|
||
<p>The two slices returned go from the start of the string slice to <code>mid</code>,
|
||
and from <code>mid</code> to the end of the string slice.</p>
|
||
<p>To get mutable string slices instead, see the <a href="https://doc.rust-lang.org/nightly/std/primitive.str.html#method.split_at_mut"><code>split_at_mut</code></a>
|
||
method.</p>
|
||
<h5 id="panics-1"><a href="#panics-1">Panics</a></h5>
|
||
<p>Panics if <code>mid</code> is not on a UTF-8 code point boundary, or if it is
|
||
past the end of the last code point of the string slice.</p>
|
||
<h5 id="examples-13"><a href="#examples-13">Examples</a></h5>
|
||
<p>Basic usage:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>s = <span class="string">"Per Martin-Lรถf"</span>;
|
||
|
||
<span class="kw">let </span>(first, last) = s.split_at(<span class="number">3</span>);
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="string">"Per"</span>, first);
|
||
<span class="macro">assert_eq!</span>(<span class="string">" Martin-Lรถf"</span>, last);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.split_at_mut" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.4.0">1.4.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#716">source</a></span><h4 class="code-header">pub fn <a href="#method.split_at_mut" class="fnname">split_at_mut</a>(&mut self, mid: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> (&mut <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, &mut <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>)</h4></section></summary><div class="docblock"><p>Divide one mutable string slice into two at an index.</p>
|
||
<p>The argument, <code>mid</code>, should be a byte offset from the start of the
|
||
string. It must also be on the boundary of a UTF-8 code point.</p>
|
||
<p>The two slices returned go from the start of the string slice to <code>mid</code>,
|
||
and from <code>mid</code> to the end of the string slice.</p>
|
||
<p>To get immutable string slices instead, see the <a href="https://doc.rust-lang.org/nightly/std/primitive.str.html#method.split_at"><code>split_at</code></a> method.</p>
|
||
<h5 id="panics-2"><a href="#panics-2">Panics</a></h5>
|
||
<p>Panics if <code>mid</code> is not on a UTF-8 code point boundary, or if it is
|
||
past the end of the last code point of the string slice.</p>
|
||
<h5 id="examples-14"><a href="#examples-14">Examples</a></h5>
|
||
<p>Basic usage:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>s = <span class="string">"Per Martin-Lรถf"</span>.to_string();
|
||
{
|
||
<span class="kw">let </span>(first, last) = s.split_at_mut(<span class="number">3</span>);
|
||
first.make_ascii_uppercase();
|
||
<span class="macro">assert_eq!</span>(<span class="string">"PER"</span>, first);
|
||
<span class="macro">assert_eq!</span>(<span class="string">" Martin-Lรถf"</span>, last);
|
||
}
|
||
<span class="macro">assert_eq!</span>(<span class="string">"PER Martin-Lรถf"</span>, s);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.chars" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#782">source</a></span><h4 class="code-header">pub fn <a href="#method.chars" class="fnname">chars</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/str/iter/struct.Chars.html" title="struct core::str::iter::Chars">Chars</a><'_></h4></section></summary><div class="docblock"><p>Returns an iterator over the <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a>s of a string slice.</p>
|
||
<p>As a string slice consists of valid UTF-8, we can iterate through a
|
||
string slice by <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a>. This method returns such an iterator.</p>
|
||
<p>Itโs important to remember that <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a> represents a Unicode Scalar
|
||
Value, and might not match your idea of what a โcharacterโ is. Iteration
|
||
over grapheme clusters may be what you actually want. This functionality
|
||
is not provided by Rustโs standard library, check crates.io instead.</p>
|
||
<h5 id="examples-15"><a href="#examples-15">Examples</a></h5>
|
||
<p>Basic usage:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>word = <span class="string">"goodbye"</span>;
|
||
|
||
<span class="kw">let </span>count = word.chars().count();
|
||
<span class="macro">assert_eq!</span>(<span class="number">7</span>, count);
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>chars = word.chars();
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(<span class="string">'g'</span>), chars.next());
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(<span class="string">'o'</span>), chars.next());
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(<span class="string">'o'</span>), chars.next());
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(<span class="string">'d'</span>), chars.next());
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(<span class="string">'b'</span>), chars.next());
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(<span class="string">'y'</span>), chars.next());
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(<span class="string">'e'</span>), chars.next());
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">None</span>, chars.next());</code></pre></div>
|
||
<p>Remember, <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a>s might not match your intuition about characters:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>y = <span class="string">"yฬ"</span>;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>chars = y.chars();
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(<span class="string">'y'</span>), chars.next()); <span class="comment">// not 'yฬ'
|
||
</span><span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(<span class="string">'\u{0306}'</span>), chars.next());
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">None</span>, chars.next());</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.char_indices" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#839">source</a></span><h4 class="code-header">pub fn <a href="#method.char_indices" class="fnname">char_indices</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/str/iter/struct.CharIndices.html" title="struct core::str::iter::CharIndices">CharIndices</a><'_></h4></section></summary><div class="docblock"><p>Returns an iterator over the <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a>s of a string slice, and their
|
||
positions.</p>
|
||
<p>As a string slice consists of valid UTF-8, we can iterate through a
|
||
string slice by <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a>. This method returns an iterator of both
|
||
these <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a>s, as well as their byte positions.</p>
|
||
<p>The iterator yields tuples. The position is first, the <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a> is
|
||
second.</p>
|
||
<h5 id="examples-16"><a href="#examples-16">Examples</a></h5>
|
||
<p>Basic usage:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>word = <span class="string">"goodbye"</span>;
|
||
|
||
<span class="kw">let </span>count = word.char_indices().count();
|
||
<span class="macro">assert_eq!</span>(<span class="number">7</span>, count);
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>char_indices = word.char_indices();
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>((<span class="number">0</span>, <span class="string">'g'</span>)), char_indices.next());
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>((<span class="number">1</span>, <span class="string">'o'</span>)), char_indices.next());
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>((<span class="number">2</span>, <span class="string">'o'</span>)), char_indices.next());
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>((<span class="number">3</span>, <span class="string">'d'</span>)), char_indices.next());
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>((<span class="number">4</span>, <span class="string">'b'</span>)), char_indices.next());
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>((<span class="number">5</span>, <span class="string">'y'</span>)), char_indices.next());
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>((<span class="number">6</span>, <span class="string">'e'</span>)), char_indices.next());
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">None</span>, char_indices.next());</code></pre></div>
|
||
<p>Remember, <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a>s might not match your intuition about characters:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>yes = <span class="string">"yฬes"</span>;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>char_indices = yes.char_indices();
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>((<span class="number">0</span>, <span class="string">'y'</span>)), char_indices.next()); <span class="comment">// not (0, 'yฬ')
|
||
</span><span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>((<span class="number">1</span>, <span class="string">'\u{0306}'</span>)), char_indices.next());
|
||
|
||
<span class="comment">// note the 3 here - the last character took up two bytes
|
||
</span><span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>((<span class="number">3</span>, <span class="string">'e'</span>)), char_indices.next());
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>((<span class="number">4</span>, <span class="string">'s'</span>)), char_indices.next());
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">None</span>, char_indices.next());</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.bytes" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#864">source</a></span><h4 class="code-header">pub fn <a href="#method.bytes" class="fnname">bytes</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/str/iter/struct.Bytes.html" title="struct core::str::iter::Bytes">Bytes</a><'_></h4></section></summary><div class="docblock"><p>An iterator over the bytes of a string slice.</p>
|
||
<p>As a string slice consists of a sequence of bytes, we can iterate
|
||
through a string slice by byte. This method returns such an iterator.</p>
|
||
<h5 id="examples-17"><a href="#examples-17">Examples</a></h5>
|
||
<p>Basic usage:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>bytes = <span class="string">"bors"</span>.bytes();
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(<span class="string">b'b'</span>), bytes.next());
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(<span class="string">b'o'</span>), bytes.next());
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(<span class="string">b'r'</span>), bytes.next());
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(<span class="string">b's'</span>), bytes.next());
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">None</span>, bytes.next());</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.split_whitespace" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.1.0">1.1.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#910">source</a></span><h4 class="code-header">pub fn <a href="#method.split_whitespace" class="fnname">split_whitespace</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/str/iter/struct.SplitWhitespace.html" title="struct core::str::iter::SplitWhitespace">SplitWhitespace</a><'_></h4></section></summary><div class="docblock"><p>Splits a string slice by whitespace.</p>
|
||
<p>The iterator returned will return string slices that are sub-slices of
|
||
the original string slice, separated by any amount of whitespace.</p>
|
||
<p>โWhitespaceโ is defined according to the terms of the Unicode Derived
|
||
Core Property <code>White_Space</code>. If you only want to split on ASCII whitespace
|
||
instead, use <a href="https://doc.rust-lang.org/nightly/std/primitive.str.html#method.split_ascii_whitespace"><code>split_ascii_whitespace</code></a>.</p>
|
||
<h5 id="examples-18"><a href="#examples-18">Examples</a></h5>
|
||
<p>Basic usage:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>iter = <span class="string">"A few words"</span>.split_whitespace();
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(<span class="string">"A"</span>), iter.next());
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(<span class="string">"few"</span>), iter.next());
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(<span class="string">"words"</span>), iter.next());
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">None</span>, iter.next());</code></pre></div>
|
||
<p>All kinds of whitespace are considered:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>iter = <span class="string">" Mary had\ta\u{2009}little \n\t lamb"</span>.split_whitespace();
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(<span class="string">"Mary"</span>), iter.next());
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(<span class="string">"had"</span>), iter.next());
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(<span class="string">"a"</span>), iter.next());
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(<span class="string">"little"</span>), iter.next());
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(<span class="string">"lamb"</span>), iter.next());
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">None</span>, iter.next());</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.split_ascii_whitespace" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.34.0">1.34.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#953">source</a></span><h4 class="code-header">pub fn <a href="#method.split_ascii_whitespace" class="fnname">split_ascii_whitespace</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/str/iter/struct.SplitAsciiWhitespace.html" title="struct core::str::iter::SplitAsciiWhitespace">SplitAsciiWhitespace</a><'_></h4></section></summary><div class="docblock"><p>Splits a string slice by ASCII whitespace.</p>
|
||
<p>The iterator returned will return string slices that are sub-slices of
|
||
the original string slice, separated by any amount of ASCII whitespace.</p>
|
||
<p>To split by Unicode <code>Whitespace</code> instead, use <a href="https://doc.rust-lang.org/nightly/std/primitive.str.html#method.split_whitespace"><code>split_whitespace</code></a>.</p>
|
||
<h5 id="examples-19"><a href="#examples-19">Examples</a></h5>
|
||
<p>Basic usage:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>iter = <span class="string">"A few words"</span>.split_ascii_whitespace();
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(<span class="string">"A"</span>), iter.next());
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(<span class="string">"few"</span>), iter.next());
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(<span class="string">"words"</span>), iter.next());
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">None</span>, iter.next());</code></pre></div>
|
||
<p>All kinds of ASCII whitespace are considered:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>iter = <span class="string">" Mary had\ta little \n\t lamb"</span>.split_ascii_whitespace();
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(<span class="string">"Mary"</span>), iter.next());
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(<span class="string">"had"</span>), iter.next());
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(<span class="string">"a"</span>), iter.next());
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(<span class="string">"little"</span>), iter.next());
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(<span class="string">"lamb"</span>), iter.next());
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">None</span>, iter.next());</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.lines" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#999">source</a></span><h4 class="code-header">pub fn <a href="#method.lines" class="fnname">lines</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/str/iter/struct.Lines.html" title="struct core::str::iter::Lines">Lines</a><'_></h4></section></summary><div class="docblock"><p>An iterator over the lines of a string, as string slices.</p>
|
||
<p>Lines are ended with either a newline (<code>\n</code>) or a carriage return with
|
||
a line feed (<code>\r\n</code>).</p>
|
||
<p>The final line ending is optional. A string that ends with a final line
|
||
ending will return the same lines as an otherwise identical string
|
||
without a final line ending.</p>
|
||
<h5 id="examples-20"><a href="#examples-20">Examples</a></h5>
|
||
<p>Basic usage:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>text = <span class="string">"foo\r\nbar\n\nbaz\n"</span>;
|
||
<span class="kw">let </span><span class="kw-2">mut </span>lines = text.lines();
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(<span class="string">"foo"</span>), lines.next());
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(<span class="string">"bar"</span>), lines.next());
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(<span class="string">""</span>), lines.next());
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(<span class="string">"baz"</span>), lines.next());
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">None</span>, lines.next());</code></pre></div>
|
||
<p>The final line ending isnโt required:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>text = <span class="string">"foo\nbar\n\r\nbaz"</span>;
|
||
<span class="kw">let </span><span class="kw-2">mut </span>lines = text.lines();
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(<span class="string">"foo"</span>), lines.next());
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(<span class="string">"bar"</span>), lines.next());
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(<span class="string">""</span>), lines.next());
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(<span class="string">"baz"</span>), lines.next());
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">None</span>, lines.next());</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.lines_any" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#1008">source</a></span><h4 class="code-header">pub fn <a href="#method.lines_any" class="fnname">lines_any</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/str/iter/struct.LinesAny.html" title="struct core::str::iter::LinesAny">LinesAny</a><'_></h4></section><span class="item-info"><div class="stab deprecated"><span class="emoji">๐</span><span>Deprecated since 1.4.0: use lines() instead now</span></div></span></summary><div class="docblock"><p>An iterator over the lines of a string.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.encode_utf16" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.8.0">1.8.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#1029">source</a></span><h4 class="code-header">pub fn <a href="#method.encode_utf16" class="fnname">encode_utf16</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/str/iter/struct.EncodeUtf16.html" title="struct core::str::iter::EncodeUtf16">EncodeUtf16</a><'_></h4></section></summary><div class="docblock"><p>Returns an iterator of <code>u16</code> over the string encoded as UTF-16.</p>
|
||
<h5 id="examples-21"><a href="#examples-21">Examples</a></h5>
|
||
<p>Basic usage:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>text = <span class="string">"Zaลผรณลฤ gฤลlฤ
jaลบล"</span>;
|
||
|
||
<span class="kw">let </span>utf8_len = text.len();
|
||
<span class="kw">let </span>utf16_len = text.encode_utf16().count();
|
||
|
||
<span class="macro">assert!</span>(utf16_len <= utf8_len);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.contains" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#1056">source</a></span><h4 class="code-header">pub fn <a href="#method.contains" class="fnname">contains</a><'a, P>(&'a self, pat: P) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a><span class="where fmt-newline">where<br> P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.Pattern.html" title="trait core::str::pattern::Pattern">Pattern</a><'a>,</span></h4></section></summary><div class="docblock"><p>Returns <code>true</code> if the given pattern matches a sub-slice of
|
||
this string slice.</p>
|
||
<p>Returns <code>false</code> if it does not.</p>
|
||
<p>The <a href="https://doc.rust-lang.org/nightly/core/str/pattern/index.html">pattern</a> can be a <code>&str</code>, <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a>, a slice of <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a>s, or a
|
||
function or closure that determines if a character matches.</p>
|
||
<h5 id="examples-22"><a href="#examples-22">Examples</a></h5>
|
||
<p>Basic usage:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>bananas = <span class="string">"bananas"</span>;
|
||
|
||
<span class="macro">assert!</span>(bananas.contains(<span class="string">"nana"</span>));
|
||
<span class="macro">assert!</span>(!bananas.contains(<span class="string">"apples"</span>));</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.starts_with" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#1082">source</a></span><h4 class="code-header">pub fn <a href="#method.starts_with" class="fnname">starts_with</a><'a, P>(&'a self, pat: P) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a><span class="where fmt-newline">where<br> P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.Pattern.html" title="trait core::str::pattern::Pattern">Pattern</a><'a>,</span></h4></section></summary><div class="docblock"><p>Returns <code>true</code> if the given pattern matches a prefix of this
|
||
string slice.</p>
|
||
<p>Returns <code>false</code> if it does not.</p>
|
||
<p>The <a href="https://doc.rust-lang.org/nightly/core/str/pattern/index.html">pattern</a> can be a <code>&str</code>, <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a>, a slice of <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a>s, or a
|
||
function or closure that determines if a character matches.</p>
|
||
<h5 id="examples-23"><a href="#examples-23">Examples</a></h5>
|
||
<p>Basic usage:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>bananas = <span class="string">"bananas"</span>;
|
||
|
||
<span class="macro">assert!</span>(bananas.starts_with(<span class="string">"bana"</span>));
|
||
<span class="macro">assert!</span>(!bananas.starts_with(<span class="string">"nana"</span>));</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.ends_with" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#1108-1110">source</a></span><h4 class="code-header">pub fn <a href="#method.ends_with" class="fnname">ends_with</a><'a, P>(&'a self, pat: P) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a><span class="where fmt-newline">where<br> P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.Pattern.html" title="trait core::str::pattern::Pattern">Pattern</a><'a>,<br> <P as <a class="trait" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.Pattern.html" title="trait core::str::pattern::Pattern">Pattern</a><'a>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.Pattern.html#associatedtype.Searcher" title="type core::str::pattern::Pattern::Searcher">Searcher</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.ReverseSearcher.html" title="trait core::str::pattern::ReverseSearcher">ReverseSearcher</a><'a>,</span></h4></section></summary><div class="docblock"><p>Returns <code>true</code> if the given pattern matches a suffix of this
|
||
string slice.</p>
|
||
<p>Returns <code>false</code> if it does not.</p>
|
||
<p>The <a href="https://doc.rust-lang.org/nightly/core/str/pattern/index.html">pattern</a> can be a <code>&str</code>, <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a>, a slice of <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a>s, or a
|
||
function or closure that determines if a character matches.</p>
|
||
<h5 id="examples-24"><a href="#examples-24">Examples</a></h5>
|
||
<p>Basic usage:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>bananas = <span class="string">"bananas"</span>;
|
||
|
||
<span class="macro">assert!</span>(bananas.ends_with(<span class="string">"anas"</span>));
|
||
<span class="macro">assert!</span>(!bananas.ends_with(<span class="string">"nana"</span>));</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.find" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#1159">source</a></span><h4 class="code-header">pub fn <a href="#method.find" class="fnname">find</a><'a, P>(&'a self, pat: P) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>><span class="where fmt-newline">where<br> P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.Pattern.html" title="trait core::str::pattern::Pattern">Pattern</a><'a>,</span></h4></section></summary><div class="docblock"><p>Returns the byte index of the first character of this string slice that
|
||
matches the pattern.</p>
|
||
<p>Returns <a href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html#variant.None" title="None"><code>None</code></a> if the pattern doesnโt match.</p>
|
||
<p>The <a href="https://doc.rust-lang.org/nightly/core/str/pattern/index.html">pattern</a> can be a <code>&str</code>, <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a>, a slice of <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a>s, or a
|
||
function or closure that determines if a character matches.</p>
|
||
<h5 id="examples-25"><a href="#examples-25">Examples</a></h5>
|
||
<p>Simple patterns:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>s = <span class="string">"Lรถwe ่่ Lรฉopard Gepardi"</span>;
|
||
|
||
<span class="macro">assert_eq!</span>(s.find(<span class="string">'L'</span>), <span class="prelude-val">Some</span>(<span class="number">0</span>));
|
||
<span class="macro">assert_eq!</span>(s.find(<span class="string">'รฉ'</span>), <span class="prelude-val">Some</span>(<span class="number">14</span>));
|
||
<span class="macro">assert_eq!</span>(s.find(<span class="string">"pard"</span>), <span class="prelude-val">Some</span>(<span class="number">17</span>));</code></pre></div>
|
||
<p>More complex patterns using point-free style and closures:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>s = <span class="string">"Lรถwe ่่ Lรฉopard"</span>;
|
||
|
||
<span class="macro">assert_eq!</span>(s.find(char::is_whitespace), <span class="prelude-val">Some</span>(<span class="number">5</span>));
|
||
<span class="macro">assert_eq!</span>(s.find(char::is_lowercase), <span class="prelude-val">Some</span>(<span class="number">1</span>));
|
||
<span class="macro">assert_eq!</span>(s.find(|c: char| c.is_whitespace() || c.is_lowercase()), <span class="prelude-val">Some</span>(<span class="number">1</span>));
|
||
<span class="macro">assert_eq!</span>(s.find(|c: char| (c < <span class="string">'o'</span>) && (c > <span class="string">'a'</span>)), <span class="prelude-val">Some</span>(<span class="number">4</span>));</code></pre></div>
|
||
<p>Not finding the pattern:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>s = <span class="string">"Lรถwe ่่ Lรฉopard"</span>;
|
||
<span class="kw">let </span>x: <span class="kw-2">&</span>[<span class="kw">_</span>] = <span class="kw-2">&</span>[<span class="string">'1'</span>, <span class="string">'2'</span>];
|
||
|
||
<span class="macro">assert_eq!</span>(s.find(x), <span class="prelude-val">None</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.rfind" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#1205-1207">source</a></span><h4 class="code-header">pub fn <a href="#method.rfind" class="fnname">rfind</a><'a, P>(&'a self, pat: P) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>><span class="where fmt-newline">where<br> P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.Pattern.html" title="trait core::str::pattern::Pattern">Pattern</a><'a>,<br> <P as <a class="trait" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.Pattern.html" title="trait core::str::pattern::Pattern">Pattern</a><'a>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.Pattern.html#associatedtype.Searcher" title="type core::str::pattern::Pattern::Searcher">Searcher</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.ReverseSearcher.html" title="trait core::str::pattern::ReverseSearcher">ReverseSearcher</a><'a>,</span></h4></section></summary><div class="docblock"><p>Returns the byte index for the first character of the last match of the pattern in
|
||
this string slice.</p>
|
||
<p>Returns <a href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html#variant.None" title="None"><code>None</code></a> if the pattern doesnโt match.</p>
|
||
<p>The <a href="https://doc.rust-lang.org/nightly/core/str/pattern/index.html">pattern</a> can be a <code>&str</code>, <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a>, a slice of <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a>s, or a
|
||
function or closure that determines if a character matches.</p>
|
||
<h5 id="examples-26"><a href="#examples-26">Examples</a></h5>
|
||
<p>Simple patterns:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>s = <span class="string">"Lรถwe ่่ Lรฉopard Gepardi"</span>;
|
||
|
||
<span class="macro">assert_eq!</span>(s.rfind(<span class="string">'L'</span>), <span class="prelude-val">Some</span>(<span class="number">13</span>));
|
||
<span class="macro">assert_eq!</span>(s.rfind(<span class="string">'รฉ'</span>), <span class="prelude-val">Some</span>(<span class="number">14</span>));
|
||
<span class="macro">assert_eq!</span>(s.rfind(<span class="string">"pard"</span>), <span class="prelude-val">Some</span>(<span class="number">24</span>));</code></pre></div>
|
||
<p>More complex patterns with closures:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>s = <span class="string">"Lรถwe ่่ Lรฉopard"</span>;
|
||
|
||
<span class="macro">assert_eq!</span>(s.rfind(char::is_whitespace), <span class="prelude-val">Some</span>(<span class="number">12</span>));
|
||
<span class="macro">assert_eq!</span>(s.rfind(char::is_lowercase), <span class="prelude-val">Some</span>(<span class="number">20</span>));</code></pre></div>
|
||
<p>Not finding the pattern:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>s = <span class="string">"Lรถwe ่่ Lรฉopard"</span>;
|
||
<span class="kw">let </span>x: <span class="kw-2">&</span>[<span class="kw">_</span>] = <span class="kw-2">&</span>[<span class="string">'1'</span>, <span class="string">'2'</span>];
|
||
|
||
<span class="macro">assert_eq!</span>(s.rfind(x), <span class="prelude-val">None</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.split" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#1327">source</a></span><h4 class="code-header">pub fn <a href="#method.split" class="fnname">split</a><'a, P>(&'a self, pat: P) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/str/iter/struct.Split.html" title="struct core::str::iter::Split">Split</a><'a, P><span class="where fmt-newline">where<br> P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.Pattern.html" title="trait core::str::pattern::Pattern">Pattern</a><'a>,</span></h4></section></summary><div class="docblock"><p>An iterator over substrings of this string slice, separated by
|
||
characters matched by a pattern.</p>
|
||
<p>The <a href="https://doc.rust-lang.org/nightly/core/str/pattern/index.html">pattern</a> can be a <code>&str</code>, <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a>, a slice of <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a>s, or a
|
||
function or closure that determines if a character matches.</p>
|
||
<h5 id="iterator-behavior"><a href="#iterator-behavior">Iterator behavior</a></h5>
|
||
<p>The returned iterator will be a <a href="https://doc.rust-lang.org/nightly/core/iter/traits/double_ended/trait.DoubleEndedIterator.html" title="DoubleEndedIterator"><code>DoubleEndedIterator</code></a> if the pattern
|
||
allows a reverse search and forward/reverse search yields the same
|
||
elements. This is true for, e.g., <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a>, but not for <code>&str</code>.</p>
|
||
<p>If the pattern allows a reverse search but its results might differ
|
||
from a forward search, the <a href="https://doc.rust-lang.org/nightly/std/primitive.str.html#method.rsplit"><code>rsplit</code></a> method can be used.</p>
|
||
<h5 id="examples-27"><a href="#examples-27">Examples</a></h5>
|
||
<p>Simple patterns:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>v: Vec<<span class="kw-2">&</span>str> = <span class="string">"Mary had a little lamb"</span>.split(<span class="string">' '</span>).collect();
|
||
<span class="macro">assert_eq!</span>(v, [<span class="string">"Mary"</span>, <span class="string">"had"</span>, <span class="string">"a"</span>, <span class="string">"little"</span>, <span class="string">"lamb"</span>]);
|
||
|
||
<span class="kw">let </span>v: Vec<<span class="kw-2">&</span>str> = <span class="string">""</span>.split(<span class="string">'X'</span>).collect();
|
||
<span class="macro">assert_eq!</span>(v, [<span class="string">""</span>]);
|
||
|
||
<span class="kw">let </span>v: Vec<<span class="kw-2">&</span>str> = <span class="string">"lionXXtigerXleopard"</span>.split(<span class="string">'X'</span>).collect();
|
||
<span class="macro">assert_eq!</span>(v, [<span class="string">"lion"</span>, <span class="string">""</span>, <span class="string">"tiger"</span>, <span class="string">"leopard"</span>]);
|
||
|
||
<span class="kw">let </span>v: Vec<<span class="kw-2">&</span>str> = <span class="string">"lion::tiger::leopard"</span>.split(<span class="string">"::"</span>).collect();
|
||
<span class="macro">assert_eq!</span>(v, [<span class="string">"lion"</span>, <span class="string">"tiger"</span>, <span class="string">"leopard"</span>]);
|
||
|
||
<span class="kw">let </span>v: Vec<<span class="kw-2">&</span>str> = <span class="string">"abc1def2ghi"</span>.split(char::is_numeric).collect();
|
||
<span class="macro">assert_eq!</span>(v, [<span class="string">"abc"</span>, <span class="string">"def"</span>, <span class="string">"ghi"</span>]);
|
||
|
||
<span class="kw">let </span>v: Vec<<span class="kw-2">&</span>str> = <span class="string">"lionXtigerXleopard"</span>.split(char::is_uppercase).collect();
|
||
<span class="macro">assert_eq!</span>(v, [<span class="string">"lion"</span>, <span class="string">"tiger"</span>, <span class="string">"leopard"</span>]);</code></pre></div>
|
||
<p>If the pattern is a slice of chars, split on each occurrence of any of the characters:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>v: Vec<<span class="kw-2">&</span>str> = <span class="string">"2020-11-03 23:59"</span>.split(<span class="kw-2">&</span>[<span class="string">'-'</span>, <span class="string">' '</span>, <span class="string">':'</span>, <span class="string">'@'</span>][..]).collect();
|
||
<span class="macro">assert_eq!</span>(v, [<span class="string">"2020"</span>, <span class="string">"11"</span>, <span class="string">"03"</span>, <span class="string">"23"</span>, <span class="string">"59"</span>]);</code></pre></div>
|
||
<p>A more complex pattern, using a closure:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>v: Vec<<span class="kw-2">&</span>str> = <span class="string">"abc1defXghi"</span>.split(|c| c == <span class="string">'1' </span>|| c == <span class="string">'X'</span>).collect();
|
||
<span class="macro">assert_eq!</span>(v, [<span class="string">"abc"</span>, <span class="string">"def"</span>, <span class="string">"ghi"</span>]);</code></pre></div>
|
||
<p>If a string contains multiple contiguous separators, you will end up
|
||
with empty strings in the output:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>x = <span class="string">"||||a||b|c"</span>.to_string();
|
||
<span class="kw">let </span>d: Vec<<span class="kw">_</span>> = x.split(<span class="string">'|'</span>).collect();
|
||
|
||
<span class="macro">assert_eq!</span>(d, <span class="kw-2">&</span>[<span class="string">""</span>, <span class="string">""</span>, <span class="string">""</span>, <span class="string">""</span>, <span class="string">"a"</span>, <span class="string">""</span>, <span class="string">"b"</span>, <span class="string">"c"</span>]);</code></pre></div>
|
||
<p>Contiguous separators are separated by the empty string.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>x = <span class="string">"(///)"</span>.to_string();
|
||
<span class="kw">let </span>d: Vec<<span class="kw">_</span>> = x.split(<span class="string">'/'</span>).collect();
|
||
|
||
<span class="macro">assert_eq!</span>(d, <span class="kw-2">&</span>[<span class="string">"("</span>, <span class="string">""</span>, <span class="string">""</span>, <span class="string">")"</span>]);</code></pre></div>
|
||
<p>Separators at the start or end of a string are neighbored
|
||
by empty strings.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>d: Vec<<span class="kw">_</span>> = <span class="string">"010"</span>.split(<span class="string">"0"</span>).collect();
|
||
<span class="macro">assert_eq!</span>(d, <span class="kw-2">&</span>[<span class="string">""</span>, <span class="string">"1"</span>, <span class="string">""</span>]);</code></pre></div>
|
||
<p>When the empty string is used as a separator, it separates
|
||
every character in the string, along with the beginning
|
||
and end of the string.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>f: Vec<<span class="kw">_</span>> = <span class="string">"rust"</span>.split(<span class="string">""</span>).collect();
|
||
<span class="macro">assert_eq!</span>(f, <span class="kw-2">&</span>[<span class="string">""</span>, <span class="string">"r"</span>, <span class="string">"u"</span>, <span class="string">"s"</span>, <span class="string">"t"</span>, <span class="string">""</span>]);</code></pre></div>
|
||
<p>Contiguous separators can lead to possibly surprising behavior
|
||
when whitespace is used as the separator. This code is correct:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>x = <span class="string">" a b c"</span>.to_string();
|
||
<span class="kw">let </span>d: Vec<<span class="kw">_</span>> = x.split(<span class="string">' '</span>).collect();
|
||
|
||
<span class="macro">assert_eq!</span>(d, <span class="kw-2">&</span>[<span class="string">""</span>, <span class="string">""</span>, <span class="string">""</span>, <span class="string">""</span>, <span class="string">"a"</span>, <span class="string">""</span>, <span class="string">"b"</span>, <span class="string">"c"</span>]);</code></pre></div>
|
||
<p>It does <em>not</em> give you:</p>
|
||
|
||
<div class="example-wrap ignore"><div class='tooltip'>โ</div><pre class="rust rust-example-rendered"><code><span class="macro">assert_eq!</span>(d, <span class="kw-2">&</span>[<span class="string">"a"</span>, <span class="string">"b"</span>, <span class="string">"c"</span>]);</code></pre></div>
|
||
<p>Use <a href="https://doc.rust-lang.org/nightly/std/primitive.str.html#method.split_whitespace"><code>split_whitespace</code></a> for this behavior.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.split_inclusive" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.51.0">1.51.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#1367">source</a></span><h4 class="code-header">pub fn <a href="#method.split_inclusive" class="fnname">split_inclusive</a><'a, P>(&'a self, pat: P) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/str/iter/struct.SplitInclusive.html" title="struct core::str::iter::SplitInclusive">SplitInclusive</a><'a, P><span class="where fmt-newline">where<br> P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.Pattern.html" title="trait core::str::pattern::Pattern">Pattern</a><'a>,</span></h4></section></summary><div class="docblock"><p>An iterator over substrings of this string slice, separated by
|
||
characters matched by a pattern. Differs from the iterator produced by
|
||
<code>split</code> in that <code>split_inclusive</code> leaves the matched part as the
|
||
terminator of the substring.</p>
|
||
<p>The <a href="https://doc.rust-lang.org/nightly/core/str/pattern/index.html">pattern</a> can be a <code>&str</code>, <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a>, a slice of <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a>s, or a
|
||
function or closure that determines if a character matches.</p>
|
||
<h5 id="examples-28"><a href="#examples-28">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>v: Vec<<span class="kw-2">&</span>str> = <span class="string">"Mary had a little lamb\nlittle lamb\nlittle lamb."
|
||
</span>.split_inclusive(<span class="string">'\n'</span>).collect();
|
||
<span class="macro">assert_eq!</span>(v, [<span class="string">"Mary had a little lamb\n"</span>, <span class="string">"little lamb\n"</span>, <span class="string">"little lamb."</span>]);</code></pre></div>
|
||
<p>If the last element of the string is matched,
|
||
that element will be considered the terminator of the preceding substring.
|
||
That substring will be the last item returned by the iterator.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>v: Vec<<span class="kw-2">&</span>str> = <span class="string">"Mary had a little lamb\nlittle lamb\nlittle lamb.\n"
|
||
</span>.split_inclusive(<span class="string">'\n'</span>).collect();
|
||
<span class="macro">assert_eq!</span>(v, [<span class="string">"Mary had a little lamb\n"</span>, <span class="string">"little lamb\n"</span>, <span class="string">"little lamb.\n"</span>]);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.rsplit" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#1422-1424">source</a></span><h4 class="code-header">pub fn <a href="#method.rsplit" class="fnname">rsplit</a><'a, P>(&'a self, pat: P) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/str/iter/struct.RSplit.html" title="struct core::str::iter::RSplit">RSplit</a><'a, P><span class="where fmt-newline">where<br> P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.Pattern.html" title="trait core::str::pattern::Pattern">Pattern</a><'a>,<br> <P as <a class="trait" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.Pattern.html" title="trait core::str::pattern::Pattern">Pattern</a><'a>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.Pattern.html#associatedtype.Searcher" title="type core::str::pattern::Pattern::Searcher">Searcher</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.ReverseSearcher.html" title="trait core::str::pattern::ReverseSearcher">ReverseSearcher</a><'a>,</span></h4></section></summary><div class="docblock"><p>An iterator over substrings of the given string slice, separated by
|
||
characters matched by a pattern and yielded in reverse order.</p>
|
||
<p>The <a href="https://doc.rust-lang.org/nightly/core/str/pattern/index.html">pattern</a> can be a <code>&str</code>, <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a>, a slice of <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a>s, or a
|
||
function or closure that determines if a character matches.</p>
|
||
<h5 id="iterator-behavior-1"><a href="#iterator-behavior-1">Iterator behavior</a></h5>
|
||
<p>The returned iterator requires that the pattern supports a reverse
|
||
search, and it will be a <a href="https://doc.rust-lang.org/nightly/core/iter/traits/double_ended/trait.DoubleEndedIterator.html" title="DoubleEndedIterator"><code>DoubleEndedIterator</code></a> if a forward/reverse
|
||
search yields the same elements.</p>
|
||
<p>For iterating from the front, the <a href="https://doc.rust-lang.org/nightly/std/primitive.str.html#method.split"><code>split</code></a> method can be used.</p>
|
||
<h5 id="examples-29"><a href="#examples-29">Examples</a></h5>
|
||
<p>Simple patterns:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>v: Vec<<span class="kw-2">&</span>str> = <span class="string">"Mary had a little lamb"</span>.rsplit(<span class="string">' '</span>).collect();
|
||
<span class="macro">assert_eq!</span>(v, [<span class="string">"lamb"</span>, <span class="string">"little"</span>, <span class="string">"a"</span>, <span class="string">"had"</span>, <span class="string">"Mary"</span>]);
|
||
|
||
<span class="kw">let </span>v: Vec<<span class="kw-2">&</span>str> = <span class="string">""</span>.rsplit(<span class="string">'X'</span>).collect();
|
||
<span class="macro">assert_eq!</span>(v, [<span class="string">""</span>]);
|
||
|
||
<span class="kw">let </span>v: Vec<<span class="kw-2">&</span>str> = <span class="string">"lionXXtigerXleopard"</span>.rsplit(<span class="string">'X'</span>).collect();
|
||
<span class="macro">assert_eq!</span>(v, [<span class="string">"leopard"</span>, <span class="string">"tiger"</span>, <span class="string">""</span>, <span class="string">"lion"</span>]);
|
||
|
||
<span class="kw">let </span>v: Vec<<span class="kw-2">&</span>str> = <span class="string">"lion::tiger::leopard"</span>.rsplit(<span class="string">"::"</span>).collect();
|
||
<span class="macro">assert_eq!</span>(v, [<span class="string">"leopard"</span>, <span class="string">"tiger"</span>, <span class="string">"lion"</span>]);</code></pre></div>
|
||
<p>A more complex pattern, using a closure:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>v: Vec<<span class="kw-2">&</span>str> = <span class="string">"abc1defXghi"</span>.rsplit(|c| c == <span class="string">'1' </span>|| c == <span class="string">'X'</span>).collect();
|
||
<span class="macro">assert_eq!</span>(v, [<span class="string">"ghi"</span>, <span class="string">"def"</span>, <span class="string">"abc"</span>]);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.split_terminator" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#1473">source</a></span><h4 class="code-header">pub fn <a href="#method.split_terminator" class="fnname">split_terminator</a><'a, P>(&'a self, pat: P) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/str/iter/struct.SplitTerminator.html" title="struct core::str::iter::SplitTerminator">SplitTerminator</a><'a, P><span class="where fmt-newline">where<br> P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.Pattern.html" title="trait core::str::pattern::Pattern">Pattern</a><'a>,</span></h4></section></summary><div class="docblock"><p>An iterator over substrings of the given string slice, separated by
|
||
characters matched by a pattern.</p>
|
||
<p>The <a href="https://doc.rust-lang.org/nightly/core/str/pattern/index.html">pattern</a> can be a <code>&str</code>, <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a>, a slice of <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a>s, or a
|
||
function or closure that determines if a character matches.</p>
|
||
<p>Equivalent to <a href="https://doc.rust-lang.org/nightly/std/primitive.str.html#method.split"><code>split</code></a>, except that the trailing substring
|
||
is skipped if empty.</p>
|
||
<p>This method can be used for string data that is <em>terminated</em>,
|
||
rather than <em>separated</em> by a pattern.</p>
|
||
<h5 id="iterator-behavior-2"><a href="#iterator-behavior-2">Iterator behavior</a></h5>
|
||
<p>The returned iterator will be a <a href="https://doc.rust-lang.org/nightly/core/iter/traits/double_ended/trait.DoubleEndedIterator.html" title="DoubleEndedIterator"><code>DoubleEndedIterator</code></a> if the pattern
|
||
allows a reverse search and forward/reverse search yields the same
|
||
elements. This is true for, e.g., <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a>, but not for <code>&str</code>.</p>
|
||
<p>If the pattern allows a reverse search but its results might differ
|
||
from a forward search, the <a href="https://doc.rust-lang.org/nightly/std/primitive.str.html#method.rsplit_terminator"><code>rsplit_terminator</code></a> method can be used.</p>
|
||
<h5 id="examples-30"><a href="#examples-30">Examples</a></h5>
|
||
<p>Basic usage:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>v: Vec<<span class="kw-2">&</span>str> = <span class="string">"A.B."</span>.split_terminator(<span class="string">'.'</span>).collect();
|
||
<span class="macro">assert_eq!</span>(v, [<span class="string">"A"</span>, <span class="string">"B"</span>]);
|
||
|
||
<span class="kw">let </span>v: Vec<<span class="kw-2">&</span>str> = <span class="string">"A..B.."</span>.split_terminator(<span class="string">"."</span>).collect();
|
||
<span class="macro">assert_eq!</span>(v, [<span class="string">"A"</span>, <span class="string">""</span>, <span class="string">"B"</span>, <span class="string">""</span>]);
|
||
|
||
<span class="kw">let </span>v: Vec<<span class="kw-2">&</span>str> = <span class="string">"A.B:C.D"</span>.split_terminator(<span class="kw-2">&</span>[<span class="string">'.'</span>, <span class="string">':'</span>][..]).collect();
|
||
<span class="macro">assert_eq!</span>(v, [<span class="string">"A"</span>, <span class="string">"B"</span>, <span class="string">"C"</span>, <span class="string">"D"</span>]);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.rsplit_terminator" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#1519-1521">source</a></span><h4 class="code-header">pub fn <a href="#method.rsplit_terminator" class="fnname">rsplit_terminator</a><'a, P>(&'a self, pat: P) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/str/iter/struct.RSplitTerminator.html" title="struct core::str::iter::RSplitTerminator">RSplitTerminator</a><'a, P><span class="where fmt-newline">where<br> P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.Pattern.html" title="trait core::str::pattern::Pattern">Pattern</a><'a>,<br> <P as <a class="trait" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.Pattern.html" title="trait core::str::pattern::Pattern">Pattern</a><'a>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.Pattern.html#associatedtype.Searcher" title="type core::str::pattern::Pattern::Searcher">Searcher</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.ReverseSearcher.html" title="trait core::str::pattern::ReverseSearcher">ReverseSearcher</a><'a>,</span></h4></section></summary><div class="docblock"><p>An iterator over substrings of <code>self</code>, separated by characters
|
||
matched by a pattern and yielded in reverse order.</p>
|
||
<p>The <a href="https://doc.rust-lang.org/nightly/core/str/pattern/index.html">pattern</a> can be a <code>&str</code>, <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a>, a slice of <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a>s, or a
|
||
function or closure that determines if a character matches.</p>
|
||
<p>Equivalent to <a href="https://doc.rust-lang.org/nightly/std/primitive.str.html#method.split"><code>split</code></a>, except that the trailing substring is
|
||
skipped if empty.</p>
|
||
<p>This method can be used for string data that is <em>terminated</em>,
|
||
rather than <em>separated</em> by a pattern.</p>
|
||
<h5 id="iterator-behavior-3"><a href="#iterator-behavior-3">Iterator behavior</a></h5>
|
||
<p>The returned iterator requires that the pattern supports a
|
||
reverse search, and it will be double ended if a forward/reverse
|
||
search yields the same elements.</p>
|
||
<p>For iterating from the front, the <a href="https://doc.rust-lang.org/nightly/std/primitive.str.html#method.split_terminator"><code>split_terminator</code></a> method can be
|
||
used.</p>
|
||
<h5 id="examples-31"><a href="#examples-31">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>v: Vec<<span class="kw-2">&</span>str> = <span class="string">"A.B."</span>.rsplit_terminator(<span class="string">'.'</span>).collect();
|
||
<span class="macro">assert_eq!</span>(v, [<span class="string">"B"</span>, <span class="string">"A"</span>]);
|
||
|
||
<span class="kw">let </span>v: Vec<<span class="kw-2">&</span>str> = <span class="string">"A..B.."</span>.rsplit_terminator(<span class="string">"."</span>).collect();
|
||
<span class="macro">assert_eq!</span>(v, [<span class="string">""</span>, <span class="string">"B"</span>, <span class="string">""</span>, <span class="string">"A"</span>]);
|
||
|
||
<span class="kw">let </span>v: Vec<<span class="kw-2">&</span>str> = <span class="string">"A.B:C.D"</span>.rsplit_terminator(<span class="kw-2">&</span>[<span class="string">'.'</span>, <span class="string">':'</span>][..]).collect();
|
||
<span class="macro">assert_eq!</span>(v, [<span class="string">"D"</span>, <span class="string">"C"</span>, <span class="string">"B"</span>, <span class="string">"A"</span>]);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.splitn" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#1574">source</a></span><h4 class="code-header">pub fn <a href="#method.splitn" class="fnname">splitn</a><'a, P>(&'a self, n: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, pat: P) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/str/iter/struct.SplitN.html" title="struct core::str::iter::SplitN">SplitN</a><'a, P><span class="where fmt-newline">where<br> P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.Pattern.html" title="trait core::str::pattern::Pattern">Pattern</a><'a>,</span></h4></section></summary><div class="docblock"><p>An iterator over substrings of the given string slice, separated by a
|
||
pattern, restricted to returning at most <code>n</code> items.</p>
|
||
<p>If <code>n</code> substrings are returned, the last substring (the <code>n</code>th substring)
|
||
will contain the remainder of the string.</p>
|
||
<p>The <a href="https://doc.rust-lang.org/nightly/core/str/pattern/index.html">pattern</a> can be a <code>&str</code>, <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a>, a slice of <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a>s, or a
|
||
function or closure that determines if a character matches.</p>
|
||
<h5 id="iterator-behavior-4"><a href="#iterator-behavior-4">Iterator behavior</a></h5>
|
||
<p>The returned iterator will not be double ended, because it is
|
||
not efficient to support.</p>
|
||
<p>If the pattern allows a reverse search, the <a href="https://doc.rust-lang.org/nightly/std/primitive.str.html#method.rsplitn"><code>rsplitn</code></a> method can be
|
||
used.</p>
|
||
<h5 id="examples-32"><a href="#examples-32">Examples</a></h5>
|
||
<p>Simple patterns:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>v: Vec<<span class="kw-2">&</span>str> = <span class="string">"Mary had a little lambda"</span>.splitn(<span class="number">3</span>, <span class="string">' '</span>).collect();
|
||
<span class="macro">assert_eq!</span>(v, [<span class="string">"Mary"</span>, <span class="string">"had"</span>, <span class="string">"a little lambda"</span>]);
|
||
|
||
<span class="kw">let </span>v: Vec<<span class="kw-2">&</span>str> = <span class="string">"lionXXtigerXleopard"</span>.splitn(<span class="number">3</span>, <span class="string">"X"</span>).collect();
|
||
<span class="macro">assert_eq!</span>(v, [<span class="string">"lion"</span>, <span class="string">""</span>, <span class="string">"tigerXleopard"</span>]);
|
||
|
||
<span class="kw">let </span>v: Vec<<span class="kw-2">&</span>str> = <span class="string">"abcXdef"</span>.splitn(<span class="number">1</span>, <span class="string">'X'</span>).collect();
|
||
<span class="macro">assert_eq!</span>(v, [<span class="string">"abcXdef"</span>]);
|
||
|
||
<span class="kw">let </span>v: Vec<<span class="kw-2">&</span>str> = <span class="string">""</span>.splitn(<span class="number">1</span>, <span class="string">'X'</span>).collect();
|
||
<span class="macro">assert_eq!</span>(v, [<span class="string">""</span>]);</code></pre></div>
|
||
<p>A more complex pattern, using a closure:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>v: Vec<<span class="kw-2">&</span>str> = <span class="string">"abc1defXghi"</span>.splitn(<span class="number">2</span>, |c| c == <span class="string">'1' </span>|| c == <span class="string">'X'</span>).collect();
|
||
<span class="macro">assert_eq!</span>(v, [<span class="string">"abc"</span>, <span class="string">"defXghi"</span>]);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.rsplitn" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#1623-1625">source</a></span><h4 class="code-header">pub fn <a href="#method.rsplitn" class="fnname">rsplitn</a><'a, P>(&'a self, n: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, pat: P) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/str/iter/struct.RSplitN.html" title="struct core::str::iter::RSplitN">RSplitN</a><'a, P><span class="where fmt-newline">where<br> P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.Pattern.html" title="trait core::str::pattern::Pattern">Pattern</a><'a>,<br> <P as <a class="trait" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.Pattern.html" title="trait core::str::pattern::Pattern">Pattern</a><'a>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.Pattern.html#associatedtype.Searcher" title="type core::str::pattern::Pattern::Searcher">Searcher</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.ReverseSearcher.html" title="trait core::str::pattern::ReverseSearcher">ReverseSearcher</a><'a>,</span></h4></section></summary><div class="docblock"><p>An iterator over substrings of this string slice, separated by a
|
||
pattern, starting from the end of the string, restricted to returning
|
||
at most <code>n</code> items.</p>
|
||
<p>If <code>n</code> substrings are returned, the last substring (the <code>n</code>th substring)
|
||
will contain the remainder of the string.</p>
|
||
<p>The <a href="https://doc.rust-lang.org/nightly/core/str/pattern/index.html">pattern</a> can be a <code>&str</code>, <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a>, a slice of <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a>s, or a
|
||
function or closure that determines if a character matches.</p>
|
||
<h5 id="iterator-behavior-5"><a href="#iterator-behavior-5">Iterator behavior</a></h5>
|
||
<p>The returned iterator will not be double ended, because it is not
|
||
efficient to support.</p>
|
||
<p>For splitting from the front, the <a href="https://doc.rust-lang.org/nightly/std/primitive.str.html#method.splitn"><code>splitn</code></a> method can be used.</p>
|
||
<h5 id="examples-33"><a href="#examples-33">Examples</a></h5>
|
||
<p>Simple patterns:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>v: Vec<<span class="kw-2">&</span>str> = <span class="string">"Mary had a little lamb"</span>.rsplitn(<span class="number">3</span>, <span class="string">' '</span>).collect();
|
||
<span class="macro">assert_eq!</span>(v, [<span class="string">"lamb"</span>, <span class="string">"little"</span>, <span class="string">"Mary had a"</span>]);
|
||
|
||
<span class="kw">let </span>v: Vec<<span class="kw-2">&</span>str> = <span class="string">"lionXXtigerXleopard"</span>.rsplitn(<span class="number">3</span>, <span class="string">'X'</span>).collect();
|
||
<span class="macro">assert_eq!</span>(v, [<span class="string">"leopard"</span>, <span class="string">"tiger"</span>, <span class="string">"lionX"</span>]);
|
||
|
||
<span class="kw">let </span>v: Vec<<span class="kw-2">&</span>str> = <span class="string">"lion::tiger::leopard"</span>.rsplitn(<span class="number">2</span>, <span class="string">"::"</span>).collect();
|
||
<span class="macro">assert_eq!</span>(v, [<span class="string">"leopard"</span>, <span class="string">"lion::tiger"</span>]);</code></pre></div>
|
||
<p>A more complex pattern, using a closure:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>v: Vec<<span class="kw-2">&</span>str> = <span class="string">"abc1defXghi"</span>.rsplitn(<span class="number">2</span>, |c| c == <span class="string">'1' </span>|| c == <span class="string">'X'</span>).collect();
|
||
<span class="macro">assert_eq!</span>(v, [<span class="string">"ghi"</span>, <span class="string">"abc1def"</span>]);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.split_once" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.52.0">1.52.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#1643">source</a></span><h4 class="code-header">pub fn <a href="#method.split_once" class="fnname">split_once</a><'a, P>(&'a self, delimiter: P) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><(&'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, &'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>)><span class="where fmt-newline">where<br> P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.Pattern.html" title="trait core::str::pattern::Pattern">Pattern</a><'a>,</span></h4></section></summary><div class="docblock"><p>Splits the string on the first occurrence of the specified delimiter and
|
||
returns prefix before delimiter and suffix after delimiter.</p>
|
||
<h5 id="examples-34"><a href="#examples-34">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">assert_eq!</span>(<span class="string">"cfg"</span>.split_once(<span class="string">'='</span>), <span class="prelude-val">None</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="string">"cfg="</span>.split_once(<span class="string">'='</span>), <span class="prelude-val">Some</span>((<span class="string">"cfg"</span>, <span class="string">""</span>)));
|
||
<span class="macro">assert_eq!</span>(<span class="string">"cfg=foo"</span>.split_once(<span class="string">'='</span>), <span class="prelude-val">Some</span>((<span class="string">"cfg"</span>, <span class="string">"foo"</span>)));
|
||
<span class="macro">assert_eq!</span>(<span class="string">"cfg=foo=bar"</span>.split_once(<span class="string">'='</span>), <span class="prelude-val">Some</span>((<span class="string">"cfg"</span>, <span class="string">"foo=bar"</span>)));</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.rsplit_once" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.52.0">1.52.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#1661-1663">source</a></span><h4 class="code-header">pub fn <a href="#method.rsplit_once" class="fnname">rsplit_once</a><'a, P>(&'a self, delimiter: P) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><(&'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, &'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>)><span class="where fmt-newline">where<br> P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.Pattern.html" title="trait core::str::pattern::Pattern">Pattern</a><'a>,<br> <P as <a class="trait" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.Pattern.html" title="trait core::str::pattern::Pattern">Pattern</a><'a>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.Pattern.html#associatedtype.Searcher" title="type core::str::pattern::Pattern::Searcher">Searcher</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.ReverseSearcher.html" title="trait core::str::pattern::ReverseSearcher">ReverseSearcher</a><'a>,</span></h4></section></summary><div class="docblock"><p>Splits the string on the last occurrence of the specified delimiter and
|
||
returns prefix before delimiter and suffix after delimiter.</p>
|
||
<h5 id="examples-35"><a href="#examples-35">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">assert_eq!</span>(<span class="string">"cfg"</span>.rsplit_once(<span class="string">'='</span>), <span class="prelude-val">None</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="string">"cfg=foo"</span>.rsplit_once(<span class="string">'='</span>), <span class="prelude-val">Some</span>((<span class="string">"cfg"</span>, <span class="string">"foo"</span>)));
|
||
<span class="macro">assert_eq!</span>(<span class="string">"cfg=foo=bar"</span>.rsplit_once(<span class="string">'='</span>), <span class="prelude-val">Some</span>((<span class="string">"cfg=foo"</span>, <span class="string">"bar"</span>)));</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.matches" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.2.0">1.2.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#1703">source</a></span><h4 class="code-header">pub fn <a href="#method.matches" class="fnname">matches</a><'a, P>(&'a self, pat: P) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/str/iter/struct.Matches.html" title="struct core::str::iter::Matches">Matches</a><'a, P><span class="where fmt-newline">where<br> P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.Pattern.html" title="trait core::str::pattern::Pattern">Pattern</a><'a>,</span></h4></section></summary><div class="docblock"><p>An iterator over the disjoint matches of a pattern within the given string
|
||
slice.</p>
|
||
<p>The <a href="https://doc.rust-lang.org/nightly/core/str/pattern/index.html">pattern</a> can be a <code>&str</code>, <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a>, a slice of <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a>s, or a
|
||
function or closure that determines if a character matches.</p>
|
||
<h5 id="iterator-behavior-6"><a href="#iterator-behavior-6">Iterator behavior</a></h5>
|
||
<p>The returned iterator will be a <a href="https://doc.rust-lang.org/nightly/core/iter/traits/double_ended/trait.DoubleEndedIterator.html" title="DoubleEndedIterator"><code>DoubleEndedIterator</code></a> if the pattern
|
||
allows a reverse search and forward/reverse search yields the same
|
||
elements. This is true for, e.g., <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a>, but not for <code>&str</code>.</p>
|
||
<p>If the pattern allows a reverse search but its results might differ
|
||
from a forward search, the <a href="https://doc.rust-lang.org/nightly/std/primitive.str.html#method.matches"><code>rmatches</code></a> method can be used.</p>
|
||
<h5 id="examples-36"><a href="#examples-36">Examples</a></h5>
|
||
<p>Basic usage:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>v: Vec<<span class="kw-2">&</span>str> = <span class="string">"abcXXXabcYYYabc"</span>.matches(<span class="string">"abc"</span>).collect();
|
||
<span class="macro">assert_eq!</span>(v, [<span class="string">"abc"</span>, <span class="string">"abc"</span>, <span class="string">"abc"</span>]);
|
||
|
||
<span class="kw">let </span>v: Vec<<span class="kw-2">&</span>str> = <span class="string">"1abc2abc3"</span>.matches(char::is_numeric).collect();
|
||
<span class="macro">assert_eq!</span>(v, [<span class="string">"1"</span>, <span class="string">"2"</span>, <span class="string">"3"</span>]);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.rmatches" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.2.0">1.2.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#1739-1741">source</a></span><h4 class="code-header">pub fn <a href="#method.rmatches" class="fnname">rmatches</a><'a, P>(&'a self, pat: P) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/str/iter/struct.RMatches.html" title="struct core::str::iter::RMatches">RMatches</a><'a, P><span class="where fmt-newline">where<br> P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.Pattern.html" title="trait core::str::pattern::Pattern">Pattern</a><'a>,<br> <P as <a class="trait" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.Pattern.html" title="trait core::str::pattern::Pattern">Pattern</a><'a>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.Pattern.html#associatedtype.Searcher" title="type core::str::pattern::Pattern::Searcher">Searcher</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.ReverseSearcher.html" title="trait core::str::pattern::ReverseSearcher">ReverseSearcher</a><'a>,</span></h4></section></summary><div class="docblock"><p>An iterator over the disjoint matches of a pattern within this string slice,
|
||
yielded in reverse order.</p>
|
||
<p>The <a href="https://doc.rust-lang.org/nightly/core/str/pattern/index.html">pattern</a> can be a <code>&str</code>, <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a>, a slice of <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a>s, or a
|
||
function or closure that determines if a character matches.</p>
|
||
<h5 id="iterator-behavior-7"><a href="#iterator-behavior-7">Iterator behavior</a></h5>
|
||
<p>The returned iterator requires that the pattern supports a reverse
|
||
search, and it will be a <a href="https://doc.rust-lang.org/nightly/core/iter/traits/double_ended/trait.DoubleEndedIterator.html" title="DoubleEndedIterator"><code>DoubleEndedIterator</code></a> if a forward/reverse
|
||
search yields the same elements.</p>
|
||
<p>For iterating from the front, the <a href="https://doc.rust-lang.org/nightly/std/primitive.str.html#method.matches"><code>matches</code></a> method can be used.</p>
|
||
<h5 id="examples-37"><a href="#examples-37">Examples</a></h5>
|
||
<p>Basic usage:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>v: Vec<<span class="kw-2">&</span>str> = <span class="string">"abcXXXabcYYYabc"</span>.rmatches(<span class="string">"abc"</span>).collect();
|
||
<span class="macro">assert_eq!</span>(v, [<span class="string">"abc"</span>, <span class="string">"abc"</span>, <span class="string">"abc"</span>]);
|
||
|
||
<span class="kw">let </span>v: Vec<<span class="kw-2">&</span>str> = <span class="string">"1abc2abc3"</span>.rmatches(char::is_numeric).collect();
|
||
<span class="macro">assert_eq!</span>(v, [<span class="string">"3"</span>, <span class="string">"2"</span>, <span class="string">"1"</span>]);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.match_indices" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.5.0">1.5.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#1785">source</a></span><h4 class="code-header">pub fn <a href="#method.match_indices" class="fnname">match_indices</a><'a, P>(&'a self, pat: P) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/str/iter/struct.MatchIndices.html" title="struct core::str::iter::MatchIndices">MatchIndices</a><'a, P><span class="where fmt-newline">where<br> P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.Pattern.html" title="trait core::str::pattern::Pattern">Pattern</a><'a>,</span></h4></section></summary><div class="docblock"><p>An iterator over the disjoint matches of a pattern within this string
|
||
slice as well as the index that the match starts at.</p>
|
||
<p>For matches of <code>pat</code> within <code>self</code> that overlap, only the indices
|
||
corresponding to the first match are returned.</p>
|
||
<p>The <a href="https://doc.rust-lang.org/nightly/core/str/pattern/index.html">pattern</a> can be a <code>&str</code>, <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a>, a slice of <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a>s, or a
|
||
function or closure that determines if a character matches.</p>
|
||
<h5 id="iterator-behavior-8"><a href="#iterator-behavior-8">Iterator behavior</a></h5>
|
||
<p>The returned iterator will be a <a href="https://doc.rust-lang.org/nightly/core/iter/traits/double_ended/trait.DoubleEndedIterator.html" title="DoubleEndedIterator"><code>DoubleEndedIterator</code></a> if the pattern
|
||
allows a reverse search and forward/reverse search yields the same
|
||
elements. This is true for, e.g., <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a>, but not for <code>&str</code>.</p>
|
||
<p>If the pattern allows a reverse search but its results might differ
|
||
from a forward search, the <a href="https://doc.rust-lang.org/nightly/std/primitive.str.html#method.rmatch_indices"><code>rmatch_indices</code></a> method can be used.</p>
|
||
<h5 id="examples-38"><a href="#examples-38">Examples</a></h5>
|
||
<p>Basic usage:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>v: Vec<<span class="kw">_</span>> = <span class="string">"abcXXXabcYYYabc"</span>.match_indices(<span class="string">"abc"</span>).collect();
|
||
<span class="macro">assert_eq!</span>(v, [(<span class="number">0</span>, <span class="string">"abc"</span>), (<span class="number">6</span>, <span class="string">"abc"</span>), (<span class="number">12</span>, <span class="string">"abc"</span>)]);
|
||
|
||
<span class="kw">let </span>v: Vec<<span class="kw">_</span>> = <span class="string">"1abcabc2"</span>.match_indices(<span class="string">"abc"</span>).collect();
|
||
<span class="macro">assert_eq!</span>(v, [(<span class="number">1</span>, <span class="string">"abc"</span>), (<span class="number">4</span>, <span class="string">"abc"</span>)]);
|
||
|
||
<span class="kw">let </span>v: Vec<<span class="kw">_</span>> = <span class="string">"ababa"</span>.match_indices(<span class="string">"aba"</span>).collect();
|
||
<span class="macro">assert_eq!</span>(v, [(<span class="number">0</span>, <span class="string">"aba"</span>)]); <span class="comment">// only the first `aba`</span></code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.rmatch_indices" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.5.0">1.5.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#1827-1829">source</a></span><h4 class="code-header">pub fn <a href="#method.rmatch_indices" class="fnname">rmatch_indices</a><'a, P>(&'a self, pat: P) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/str/iter/struct.RMatchIndices.html" title="struct core::str::iter::RMatchIndices">RMatchIndices</a><'a, P><span class="where fmt-newline">where<br> P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.Pattern.html" title="trait core::str::pattern::Pattern">Pattern</a><'a>,<br> <P as <a class="trait" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.Pattern.html" title="trait core::str::pattern::Pattern">Pattern</a><'a>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.Pattern.html#associatedtype.Searcher" title="type core::str::pattern::Pattern::Searcher">Searcher</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.ReverseSearcher.html" title="trait core::str::pattern::ReverseSearcher">ReverseSearcher</a><'a>,</span></h4></section></summary><div class="docblock"><p>An iterator over the disjoint matches of a pattern within <code>self</code>,
|
||
yielded in reverse order along with the index of the match.</p>
|
||
<p>For matches of <code>pat</code> within <code>self</code> that overlap, only the indices
|
||
corresponding to the last match are returned.</p>
|
||
<p>The <a href="https://doc.rust-lang.org/nightly/core/str/pattern/index.html">pattern</a> can be a <code>&str</code>, <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a>, a slice of <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a>s, or a
|
||
function or closure that determines if a character matches.</p>
|
||
<h5 id="iterator-behavior-9"><a href="#iterator-behavior-9">Iterator behavior</a></h5>
|
||
<p>The returned iterator requires that the pattern supports a reverse
|
||
search, and it will be a <a href="https://doc.rust-lang.org/nightly/core/iter/traits/double_ended/trait.DoubleEndedIterator.html" title="DoubleEndedIterator"><code>DoubleEndedIterator</code></a> if a forward/reverse
|
||
search yields the same elements.</p>
|
||
<p>For iterating from the front, the <a href="https://doc.rust-lang.org/nightly/std/primitive.str.html#method.match_indices"><code>match_indices</code></a> method can be used.</p>
|
||
<h5 id="examples-39"><a href="#examples-39">Examples</a></h5>
|
||
<p>Basic usage:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>v: Vec<<span class="kw">_</span>> = <span class="string">"abcXXXabcYYYabc"</span>.rmatch_indices(<span class="string">"abc"</span>).collect();
|
||
<span class="macro">assert_eq!</span>(v, [(<span class="number">12</span>, <span class="string">"abc"</span>), (<span class="number">6</span>, <span class="string">"abc"</span>), (<span class="number">0</span>, <span class="string">"abc"</span>)]);
|
||
|
||
<span class="kw">let </span>v: Vec<<span class="kw">_</span>> = <span class="string">"1abcabc2"</span>.rmatch_indices(<span class="string">"abc"</span>).collect();
|
||
<span class="macro">assert_eq!</span>(v, [(<span class="number">4</span>, <span class="string">"abc"</span>), (<span class="number">1</span>, <span class="string">"abc"</span>)]);
|
||
|
||
<span class="kw">let </span>v: Vec<<span class="kw">_</span>> = <span class="string">"ababa"</span>.rmatch_indices(<span class="string">"aba"</span>).collect();
|
||
<span class="macro">assert_eq!</span>(v, [(<span class="number">2</span>, <span class="string">"aba"</span>)]); <span class="comment">// only the last `aba`</span></code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.trim" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#1853">source</a></span><h4 class="code-header">pub fn <a href="#method.trim" class="fnname">trim</a>(&self) -> &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a></h4></section></summary><div class="docblock"><p>Returns a string slice with leading and trailing whitespace removed.</p>
|
||
<p>โWhitespaceโ is defined according to the terms of the Unicode Derived
|
||
Core Property <code>White_Space</code>, which includes newlines.</p>
|
||
<h5 id="examples-40"><a href="#examples-40">Examples</a></h5>
|
||
<p>Basic usage:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>s = <span class="string">"\n Hello\tworld\t\n"</span>;
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="string">"Hello\tworld"</span>, s.trim());</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.trim_start" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.30.0">1.30.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#1892">source</a></span><h4 class="code-header">pub fn <a href="#method.trim_start" class="fnname">trim_start</a>(&self) -> &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a></h4></section></summary><div class="docblock"><p>Returns a string slice with leading whitespace removed.</p>
|
||
<p>โWhitespaceโ is defined according to the terms of the Unicode Derived
|
||
Core Property <code>White_Space</code>, which includes newlines.</p>
|
||
<h5 id="text-directionality"><a href="#text-directionality">Text directionality</a></h5>
|
||
<p>A string is a sequence of bytes. <code>start</code> in this context means the first
|
||
position of that byte string; for a left-to-right language like English or
|
||
Russian, this will be left side, and for right-to-left languages like
|
||
Arabic or Hebrew, this will be the right side.</p>
|
||
<h5 id="examples-41"><a href="#examples-41">Examples</a></h5>
|
||
<p>Basic usage:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>s = <span class="string">"\n Hello\tworld\t\n"</span>;
|
||
<span class="macro">assert_eq!</span>(<span class="string">"Hello\tworld\t\n"</span>, s.trim_start());</code></pre></div>
|
||
<p>Directionality:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>s = <span class="string">" English "</span>;
|
||
<span class="macro">assert!</span>(<span class="prelude-val">Some</span>(<span class="string">'E'</span>) == s.trim_start().chars().next());
|
||
|
||
<span class="kw">let </span>s = <span class="string">" ืขืืจืืช "</span>;
|
||
<span class="macro">assert!</span>(<span class="prelude-val">Some</span>(<span class="string">'ืข'</span>) == s.trim_start().chars().next());</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.trim_end" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.30.0">1.30.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#1931">source</a></span><h4 class="code-header">pub fn <a href="#method.trim_end" class="fnname">trim_end</a>(&self) -> &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a></h4></section></summary><div class="docblock"><p>Returns a string slice with trailing whitespace removed.</p>
|
||
<p>โWhitespaceโ is defined according to the terms of the Unicode Derived
|
||
Core Property <code>White_Space</code>, which includes newlines.</p>
|
||
<h5 id="text-directionality-1"><a href="#text-directionality-1">Text directionality</a></h5>
|
||
<p>A string is a sequence of bytes. <code>end</code> in this context means the last
|
||
position of that byte string; for a left-to-right language like English or
|
||
Russian, this will be right side, and for right-to-left languages like
|
||
Arabic or Hebrew, this will be the left side.</p>
|
||
<h5 id="examples-42"><a href="#examples-42">Examples</a></h5>
|
||
<p>Basic usage:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>s = <span class="string">"\n Hello\tworld\t\n"</span>;
|
||
<span class="macro">assert_eq!</span>(<span class="string">"\n Hello\tworld"</span>, s.trim_end());</code></pre></div>
|
||
<p>Directionality:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>s = <span class="string">" English "</span>;
|
||
<span class="macro">assert!</span>(<span class="prelude-val">Some</span>(<span class="string">'h'</span>) == s.trim_end().chars().rev().next());
|
||
|
||
<span class="kw">let </span>s = <span class="string">" ืขืืจืืช "</span>;
|
||
<span class="macro">assert!</span>(<span class="prelude-val">Some</span>(<span class="string">'ืช'</span>) == s.trim_end().chars().rev().next());</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.trim_left" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#1971">source</a></span><h4 class="code-header">pub fn <a href="#method.trim_left" class="fnname">trim_left</a>(&self) -> &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a></h4></section><span class="item-info"><div class="stab deprecated"><span class="emoji">๐</span><span>Deprecated since 1.33.0: superseded by <code>trim_start</code></span></div></span></summary><div class="docblock"><p>Returns a string slice with leading whitespace removed.</p>
|
||
<p>โWhitespaceโ is defined according to the terms of the Unicode Derived
|
||
Core Property <code>White_Space</code>.</p>
|
||
<h5 id="text-directionality-2"><a href="#text-directionality-2">Text directionality</a></h5>
|
||
<p>A string is a sequence of bytes. โLeftโ in this context means the first
|
||
position of that byte string; for a language like Arabic or Hebrew
|
||
which are โright to leftโ rather than โleft to rightโ, this will be
|
||
the <em>right</em> side, not the left.</p>
|
||
<h5 id="examples-43"><a href="#examples-43">Examples</a></h5>
|
||
<p>Basic usage:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>s = <span class="string">" Hello\tworld\t"</span>;
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="string">"Hello\tworld\t"</span>, s.trim_left());</code></pre></div>
|
||
<p>Directionality:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>s = <span class="string">" English"</span>;
|
||
<span class="macro">assert!</span>(<span class="prelude-val">Some</span>(<span class="string">'E'</span>) == s.trim_left().chars().next());
|
||
|
||
<span class="kw">let </span>s = <span class="string">" ืขืืจืืช"</span>;
|
||
<span class="macro">assert!</span>(<span class="prelude-val">Some</span>(<span class="string">'ืข'</span>) == s.trim_left().chars().next());</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.trim_right" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#2011">source</a></span><h4 class="code-header">pub fn <a href="#method.trim_right" class="fnname">trim_right</a>(&self) -> &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a></h4></section><span class="item-info"><div class="stab deprecated"><span class="emoji">๐</span><span>Deprecated since 1.33.0: superseded by <code>trim_end</code></span></div></span></summary><div class="docblock"><p>Returns a string slice with trailing whitespace removed.</p>
|
||
<p>โWhitespaceโ is defined according to the terms of the Unicode Derived
|
||
Core Property <code>White_Space</code>.</p>
|
||
<h5 id="text-directionality-3"><a href="#text-directionality-3">Text directionality</a></h5>
|
||
<p>A string is a sequence of bytes. โRightโ in this context means the last
|
||
position of that byte string; for a language like Arabic or Hebrew
|
||
which are โright to leftโ rather than โleft to rightโ, this will be
|
||
the <em>left</em> side, not the right.</p>
|
||
<h5 id="examples-44"><a href="#examples-44">Examples</a></h5>
|
||
<p>Basic usage:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>s = <span class="string">" Hello\tworld\t"</span>;
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="string">" Hello\tworld"</span>, s.trim_right());</code></pre></div>
|
||
<p>Directionality:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>s = <span class="string">"English "</span>;
|
||
<span class="macro">assert!</span>(<span class="prelude-val">Some</span>(<span class="string">'h'</span>) == s.trim_right().chars().rev().next());
|
||
|
||
<span class="kw">let </span>s = <span class="string">"ืขืืจืืช "</span>;
|
||
<span class="macro">assert!</span>(<span class="prelude-val">Some</span>(<span class="string">'ืช'</span>) == s.trim_right().chars().rev().next());</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.trim_matches" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#2044-2046">source</a></span><h4 class="code-header">pub fn <a href="#method.trim_matches" class="fnname">trim_matches</a><'a, P>(&'a self, pat: P) -> &'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a><span class="where fmt-newline">where<br> P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.Pattern.html" title="trait core::str::pattern::Pattern">Pattern</a><'a>,<br> <P as <a class="trait" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.Pattern.html" title="trait core::str::pattern::Pattern">Pattern</a><'a>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.Pattern.html#associatedtype.Searcher" title="type core::str::pattern::Pattern::Searcher">Searcher</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.DoubleEndedSearcher.html" title="trait core::str::pattern::DoubleEndedSearcher">DoubleEndedSearcher</a><'a>,</span></h4></section></summary><div class="docblock"><p>Returns a string slice with all prefixes and suffixes that match a
|
||
pattern repeatedly removed.</p>
|
||
<p>The <a href="https://doc.rust-lang.org/nightly/core/str/pattern/index.html">pattern</a> can be a <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a>, a slice of <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a>s, or a function
|
||
or closure that determines if a character matches.</p>
|
||
<h5 id="examples-45"><a href="#examples-45">Examples</a></h5>
|
||
<p>Simple patterns:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">assert_eq!</span>(<span class="string">"11foo1bar11"</span>.trim_matches(<span class="string">'1'</span>), <span class="string">"foo1bar"</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="string">"123foo1bar123"</span>.trim_matches(char::is_numeric), <span class="string">"foo1bar"</span>);
|
||
|
||
<span class="kw">let </span>x: <span class="kw-2">&</span>[<span class="kw">_</span>] = <span class="kw-2">&</span>[<span class="string">'1'</span>, <span class="string">'2'</span>];
|
||
<span class="macro">assert_eq!</span>(<span class="string">"12foo1bar12"</span>.trim_matches(x), <span class="string">"foo1bar"</span>);</code></pre></div>
|
||
<p>A more complex pattern, using a closure:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">assert_eq!</span>(<span class="string">"1foo1barXX"</span>.trim_matches(|c| c == <span class="string">'1' </span>|| c == <span class="string">'X'</span>), <span class="string">"foo1bar"</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.trim_start_matches" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.30.0">1.30.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#2093">source</a></span><h4 class="code-header">pub fn <a href="#method.trim_start_matches" class="fnname">trim_start_matches</a><'a, P>(&'a self, pat: P) -> &'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a><span class="where fmt-newline">where<br> P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.Pattern.html" title="trait core::str::pattern::Pattern">Pattern</a><'a>,</span></h4></section></summary><div class="docblock"><p>Returns a string slice with all prefixes that match a pattern
|
||
repeatedly removed.</p>
|
||
<p>The <a href="https://doc.rust-lang.org/nightly/core/str/pattern/index.html">pattern</a> can be a <code>&str</code>, <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a>, a slice of <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a>s, or a
|
||
function or closure that determines if a character matches.</p>
|
||
<h5 id="text-directionality-4"><a href="#text-directionality-4">Text directionality</a></h5>
|
||
<p>A string is a sequence of bytes. <code>start</code> in this context means the first
|
||
position of that byte string; for a left-to-right language like English or
|
||
Russian, this will be left side, and for right-to-left languages like
|
||
Arabic or Hebrew, this will be the right side.</p>
|
||
<h5 id="examples-46"><a href="#examples-46">Examples</a></h5>
|
||
<p>Basic usage:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">assert_eq!</span>(<span class="string">"11foo1bar11"</span>.trim_start_matches(<span class="string">'1'</span>), <span class="string">"foo1bar11"</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="string">"123foo1bar123"</span>.trim_start_matches(char::is_numeric), <span class="string">"foo1bar123"</span>);
|
||
|
||
<span class="kw">let </span>x: <span class="kw-2">&</span>[<span class="kw">_</span>] = <span class="kw-2">&</span>[<span class="string">'1'</span>, <span class="string">'2'</span>];
|
||
<span class="macro">assert_eq!</span>(<span class="string">"12foo1bar12"</span>.trim_start_matches(x), <span class="string">"foo1bar12"</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.strip_prefix" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.45.0">1.45.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#2126">source</a></span><h4 class="code-header">pub fn <a href="#method.strip_prefix" class="fnname">strip_prefix</a><'a, P>(&'a self, prefix: P) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>><span class="where fmt-newline">where<br> P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.Pattern.html" title="trait core::str::pattern::Pattern">Pattern</a><'a>,</span></h4></section></summary><div class="docblock"><p>Returns a string slice with the prefix removed.</p>
|
||
<p>If the string starts with the pattern <code>prefix</code>, returns substring after the prefix, wrapped
|
||
in <code>Some</code>. Unlike <code>trim_start_matches</code>, this method removes the prefix exactly once.</p>
|
||
<p>If the string does not start with <code>prefix</code>, returns <code>None</code>.</p>
|
||
<p>The <a href="https://doc.rust-lang.org/nightly/core/str/pattern/index.html">pattern</a> can be a <code>&str</code>, <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a>, a slice of <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a>s, or a
|
||
function or closure that determines if a character matches.</p>
|
||
<h5 id="examples-47"><a href="#examples-47">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">assert_eq!</span>(<span class="string">"foo:bar"</span>.strip_prefix(<span class="string">"foo:"</span>), <span class="prelude-val">Some</span>(<span class="string">"bar"</span>));
|
||
<span class="macro">assert_eq!</span>(<span class="string">"foo:bar"</span>.strip_prefix(<span class="string">"bar"</span>), <span class="prelude-val">None</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="string">"foofoo"</span>.strip_prefix(<span class="string">"foo"</span>), <span class="prelude-val">Some</span>(<span class="string">"foo"</span>));</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.strip_suffix" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.45.0">1.45.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#2153-2156">source</a></span><h4 class="code-header">pub fn <a href="#method.strip_suffix" class="fnname">strip_suffix</a><'a, P>(&'a self, suffix: P) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>><span class="where fmt-newline">where<br> P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.Pattern.html" title="trait core::str::pattern::Pattern">Pattern</a><'a>,<br> <P as <a class="trait" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.Pattern.html" title="trait core::str::pattern::Pattern">Pattern</a><'a>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.Pattern.html#associatedtype.Searcher" title="type core::str::pattern::Pattern::Searcher">Searcher</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.ReverseSearcher.html" title="trait core::str::pattern::ReverseSearcher">ReverseSearcher</a><'a>,</span></h4></section></summary><div class="docblock"><p>Returns a string slice with the suffix removed.</p>
|
||
<p>If the string ends with the pattern <code>suffix</code>, returns the substring before the suffix,
|
||
wrapped in <code>Some</code>. Unlike <code>trim_end_matches</code>, this method removes the suffix exactly once.</p>
|
||
<p>If the string does not end with <code>suffix</code>, returns <code>None</code>.</p>
|
||
<p>The <a href="https://doc.rust-lang.org/nightly/core/str/pattern/index.html">pattern</a> can be a <code>&str</code>, <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a>, a slice of <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a>s, or a
|
||
function or closure that determines if a character matches.</p>
|
||
<h5 id="examples-48"><a href="#examples-48">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">assert_eq!</span>(<span class="string">"bar:foo"</span>.strip_suffix(<span class="string">":foo"</span>), <span class="prelude-val">Some</span>(<span class="string">"bar"</span>));
|
||
<span class="macro">assert_eq!</span>(<span class="string">"bar:foo"</span>.strip_suffix(<span class="string">"bar"</span>), <span class="prelude-val">None</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="string">"foofoo"</span>.strip_suffix(<span class="string">"foo"</span>), <span class="prelude-val">Some</span>(<span class="string">"foo"</span>));</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.trim_end_matches" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.30.0">1.30.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#2197-2199">source</a></span><h4 class="code-header">pub fn <a href="#method.trim_end_matches" class="fnname">trim_end_matches</a><'a, P>(&'a self, pat: P) -> &'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a><span class="where fmt-newline">where<br> P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.Pattern.html" title="trait core::str::pattern::Pattern">Pattern</a><'a>,<br> <P as <a class="trait" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.Pattern.html" title="trait core::str::pattern::Pattern">Pattern</a><'a>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.Pattern.html#associatedtype.Searcher" title="type core::str::pattern::Pattern::Searcher">Searcher</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.ReverseSearcher.html" title="trait core::str::pattern::ReverseSearcher">ReverseSearcher</a><'a>,</span></h4></section></summary><div class="docblock"><p>Returns a string slice with all suffixes that match a pattern
|
||
repeatedly removed.</p>
|
||
<p>The <a href="https://doc.rust-lang.org/nightly/core/str/pattern/index.html">pattern</a> can be a <code>&str</code>, <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a>, a slice of <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a>s, or a
|
||
function or closure that determines if a character matches.</p>
|
||
<h5 id="text-directionality-5"><a href="#text-directionality-5">Text directionality</a></h5>
|
||
<p>A string is a sequence of bytes. <code>end</code> in this context means the last
|
||
position of that byte string; for a left-to-right language like English or
|
||
Russian, this will be right side, and for right-to-left languages like
|
||
Arabic or Hebrew, this will be the left side.</p>
|
||
<h5 id="examples-49"><a href="#examples-49">Examples</a></h5>
|
||
<p>Simple patterns:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">assert_eq!</span>(<span class="string">"11foo1bar11"</span>.trim_end_matches(<span class="string">'1'</span>), <span class="string">"11foo1bar"</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="string">"123foo1bar123"</span>.trim_end_matches(char::is_numeric), <span class="string">"123foo1bar"</span>);
|
||
|
||
<span class="kw">let </span>x: <span class="kw-2">&</span>[<span class="kw">_</span>] = <span class="kw-2">&</span>[<span class="string">'1'</span>, <span class="string">'2'</span>];
|
||
<span class="macro">assert_eq!</span>(<span class="string">"12foo1bar12"</span>.trim_end_matches(x), <span class="string">"12foo1bar"</span>);</code></pre></div>
|
||
<p>A more complex pattern, using a closure:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">assert_eq!</span>(<span class="string">"1fooX"</span>.trim_end_matches(|c| c == <span class="string">'1' </span>|| c == <span class="string">'X'</span>), <span class="string">"1foo"</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.trim_left_matches" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#2243">source</a></span><h4 class="code-header">pub fn <a href="#method.trim_left_matches" class="fnname">trim_left_matches</a><'a, P>(&'a self, pat: P) -> &'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a><span class="where fmt-newline">where<br> P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.Pattern.html" title="trait core::str::pattern::Pattern">Pattern</a><'a>,</span></h4></section><span class="item-info"><div class="stab deprecated"><span class="emoji">๐</span><span>Deprecated since 1.33.0: superseded by <code>trim_start_matches</code></span></div></span></summary><div class="docblock"><p>Returns a string slice with all prefixes that match a pattern
|
||
repeatedly removed.</p>
|
||
<p>The <a href="https://doc.rust-lang.org/nightly/core/str/pattern/index.html">pattern</a> can be a <code>&str</code>, <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a>, a slice of <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a>s, or a
|
||
function or closure that determines if a character matches.</p>
|
||
<h5 id="text-directionality-6"><a href="#text-directionality-6">Text directionality</a></h5>
|
||
<p>A string is a sequence of bytes. โLeftโ in this context means the first
|
||
position of that byte string; for a language like Arabic or Hebrew
|
||
which are โright to leftโ rather than โleft to rightโ, this will be
|
||
the <em>right</em> side, not the left.</p>
|
||
<h5 id="examples-50"><a href="#examples-50">Examples</a></h5>
|
||
<p>Basic usage:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">assert_eq!</span>(<span class="string">"11foo1bar11"</span>.trim_left_matches(<span class="string">'1'</span>), <span class="string">"foo1bar11"</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="string">"123foo1bar123"</span>.trim_left_matches(char::is_numeric), <span class="string">"foo1bar123"</span>);
|
||
|
||
<span class="kw">let </span>x: <span class="kw-2">&</span>[<span class="kw">_</span>] = <span class="kw-2">&</span>[<span class="string">'1'</span>, <span class="string">'2'</span>];
|
||
<span class="macro">assert_eq!</span>(<span class="string">"12foo1bar12"</span>.trim_left_matches(x), <span class="string">"foo1bar12"</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.trim_right_matches" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#2286-2288">source</a></span><h4 class="code-header">pub fn <a href="#method.trim_right_matches" class="fnname">trim_right_matches</a><'a, P>(&'a self, pat: P) -> &'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a><span class="where fmt-newline">where<br> P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.Pattern.html" title="trait core::str::pattern::Pattern">Pattern</a><'a>,<br> <P as <a class="trait" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.Pattern.html" title="trait core::str::pattern::Pattern">Pattern</a><'a>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.Pattern.html#associatedtype.Searcher" title="type core::str::pattern::Pattern::Searcher">Searcher</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.ReverseSearcher.html" title="trait core::str::pattern::ReverseSearcher">ReverseSearcher</a><'a>,</span></h4></section><span class="item-info"><div class="stab deprecated"><span class="emoji">๐</span><span>Deprecated since 1.33.0: superseded by <code>trim_end_matches</code></span></div></span></summary><div class="docblock"><p>Returns a string slice with all suffixes that match a pattern
|
||
repeatedly removed.</p>
|
||
<p>The <a href="https://doc.rust-lang.org/nightly/core/str/pattern/index.html">pattern</a> can be a <code>&str</code>, <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a>, a slice of <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html"><code>char</code></a>s, or a
|
||
function or closure that determines if a character matches.</p>
|
||
<h5 id="text-directionality-7"><a href="#text-directionality-7">Text directionality</a></h5>
|
||
<p>A string is a sequence of bytes. โRightโ in this context means the last
|
||
position of that byte string; for a language like Arabic or Hebrew
|
||
which are โright to leftโ rather than โleft to rightโ, this will be
|
||
the <em>left</em> side, not the right.</p>
|
||
<h5 id="examples-51"><a href="#examples-51">Examples</a></h5>
|
||
<p>Simple patterns:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">assert_eq!</span>(<span class="string">"11foo1bar11"</span>.trim_right_matches(<span class="string">'1'</span>), <span class="string">"11foo1bar"</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="string">"123foo1bar123"</span>.trim_right_matches(char::is_numeric), <span class="string">"123foo1bar"</span>);
|
||
|
||
<span class="kw">let </span>x: <span class="kw-2">&</span>[<span class="kw">_</span>] = <span class="kw-2">&</span>[<span class="string">'1'</span>, <span class="string">'2'</span>];
|
||
<span class="macro">assert_eq!</span>(<span class="string">"12foo1bar12"</span>.trim_right_matches(x), <span class="string">"12foo1bar"</span>);</code></pre></div>
|
||
<p>A more complex pattern, using a closure:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">assert_eq!</span>(<span class="string">"1fooX"</span>.trim_right_matches(|c| c == <span class="string">'1' </span>|| c == <span class="string">'X'</span>), <span class="string">"1foo"</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.parse" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#2338">source</a></span><h4 class="code-header">pub fn <a href="#method.parse" class="fnname">parse</a><F>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><F, <F as <a class="trait" href="https://doc.rust-lang.org/nightly/core/str/traits/trait.FromStr.html" title="trait core::str::traits::FromStr">FromStr</a>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/str/traits/trait.FromStr.html#associatedtype.Err" title="type core::str::traits::FromStr::Err">Err</a>><span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/str/traits/trait.FromStr.html" title="trait core::str::traits::FromStr">FromStr</a>,</span></h4></section></summary><div class="docblock"><p>Parses this string slice into another type.</p>
|
||
<p>Because <code>parse</code> is so general, it can cause problems with type
|
||
inference. As such, <code>parse</code> is one of the few times youโll see
|
||
the syntax affectionately known as the โturbofishโ: <code>::<></code>. This
|
||
helps the inference algorithm understand specifically which type
|
||
youโre trying to parse into.</p>
|
||
<p><code>parse</code> can parse into any type that implements the <a href="https://doc.rust-lang.org/nightly/core/str/traits/trait.FromStr.html" title="FromStr"><code>FromStr</code></a> trait.</p>
|
||
<h5 id="errors"><a href="#errors">Errors</a></h5>
|
||
<p>Will return <a href="https://doc.rust-lang.org/nightly/core/str/traits/trait.FromStr.html#associatedtype.Err"><code>Err</code></a> if itโs not possible to parse this string slice into
|
||
the desired type.</p>
|
||
<h5 id="examples-52"><a href="#examples-52">Examples</a></h5>
|
||
<p>Basic usage</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>four: u32 = <span class="string">"4"</span>.parse().unwrap();
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="number">4</span>, four);</code></pre></div>
|
||
<p>Using the โturbofishโ instead of annotating <code>four</code>:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>four = <span class="string">"4"</span>.parse::<u32>();
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">Ok</span>(<span class="number">4</span>), four);</code></pre></div>
|
||
<p>Failing to parse:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>nope = <span class="string">"j"</span>.parse::<u32>();
|
||
|
||
<span class="macro">assert!</span>(nope.is_err());</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.is_ascii" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.23.0">1.23.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#2356">source</a></span><h4 class="code-header">pub fn <a href="#method.is_ascii" class="fnname">is_ascii</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Checks if all characters in this string are within the ASCII range.</p>
|
||
<h5 id="examples-53"><a href="#examples-53">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>ascii = <span class="string">"hello!\n"</span>;
|
||
<span class="kw">let </span>non_ascii = <span class="string">"Grรผรe, Jรผrgen โค"</span>;
|
||
|
||
<span class="macro">assert!</span>(ascii.is_ascii());
|
||
<span class="macro">assert!</span>(!non_ascii.is_ascii());</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.eq_ignore_ascii_case" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.23.0">1.23.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#2378">source</a></span><h4 class="code-header">pub fn <a href="#method.eq_ignore_ascii_case" class="fnname">eq_ignore_ascii_case</a>(&self, other: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Checks that two strings are an ASCII case-insensitive match.</p>
|
||
<p>Same as <code>to_ascii_lowercase(a) == to_ascii_lowercase(b)</code>,
|
||
but without allocating and copying temporaries.</p>
|
||
<h5 id="examples-54"><a href="#examples-54">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">assert!</span>(<span class="string">"Ferris"</span>.eq_ignore_ascii_case(<span class="string">"FERRIS"</span>));
|
||
<span class="macro">assert!</span>(<span class="string">"Ferrรถs"</span>.eq_ignore_ascii_case(<span class="string">"FERRรถS"</span>));
|
||
<span class="macro">assert!</span>(!<span class="string">"Ferrรถs"</span>.eq_ignore_ascii_case(<span class="string">"FERRรS"</span>));</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.make_ascii_uppercase" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.23.0">1.23.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#2403">source</a></span><h4 class="code-header">pub fn <a href="#method.make_ascii_uppercase" class="fnname">make_ascii_uppercase</a>(&mut self)</h4></section></summary><div class="docblock"><p>Converts this string to its ASCII upper case equivalent in-place.</p>
|
||
<p>ASCII letters โaโ to โzโ are mapped to โAโ to โZโ,
|
||
but non-ASCII letters are unchanged.</p>
|
||
<p>To return a new uppercased value without modifying the existing one, use
|
||
<a href="#method.to_ascii_uppercase"><code>to_ascii_uppercase()</code></a>.</p>
|
||
<h5 id="examples-55"><a href="#examples-55">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>s = String::from(<span class="string">"Grรผรe, Jรผrgen โค"</span>);
|
||
|
||
s.make_ascii_uppercase();
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="string">"GRรผรE, JรผRGEN โค"</span>, s);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.make_ascii_lowercase" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.23.0">1.23.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#2430">source</a></span><h4 class="code-header">pub fn <a href="#method.make_ascii_lowercase" class="fnname">make_ascii_lowercase</a>(&mut self)</h4></section></summary><div class="docblock"><p>Converts this string to its ASCII lower case equivalent in-place.</p>
|
||
<p>ASCII letters โAโ to โZโ are mapped to โaโ to โzโ,
|
||
but non-ASCII letters are unchanged.</p>
|
||
<p>To return a new lowercased value without modifying the existing one, use
|
||
<a href="#method.to_ascii_lowercase"><code>to_ascii_lowercase()</code></a>.</p>
|
||
<h5 id="examples-56"><a href="#examples-56">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>s = String::from(<span class="string">"GRรรE, JรRGEN โค"</span>);
|
||
|
||
s.make_ascii_lowercase();
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="string">"grรรe, jรrgen โค"</span>, s);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.escape_debug" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.34.0">1.34.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#2473">source</a></span><h4 class="code-header">pub fn <a href="#method.escape_debug" class="fnname">escape_debug</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/str/iter/struct.EscapeDebug.html" title="struct core::str::iter::EscapeDebug">EscapeDebug</a><'_></h4></section></summary><div class="docblock"><p>Return an iterator that escapes each char in <code>self</code> with <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html#method.escape_debug" title="char::escape_debug"><code>char::escape_debug</code></a>.</p>
|
||
<p>Note: only extended grapheme codepoints that begin the string will be
|
||
escaped.</p>
|
||
<h5 id="examples-57"><a href="#examples-57">Examples</a></h5>
|
||
<p>As an iterator:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">for </span>c <span class="kw">in </span><span class="string">"โค\n!"</span>.escape_debug() {
|
||
<span class="macro">print!</span>(<span class="string">"{c}"</span>);
|
||
}
|
||
<span class="macro">println!</span>();</code></pre></div>
|
||
<p>Using <code>println!</code> directly:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"{}"</span>, <span class="string">"โค\n!"</span>.escape_debug());</code></pre></div>
|
||
<p>Both are equivalent to:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"โค\\n!"</span>);</code></pre></div>
|
||
<p>Using <code>to_string</code>:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">assert_eq!</span>(<span class="string">"โค\n!"</span>.escape_debug().to_string(), <span class="string">"โค\\n!"</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.escape_default" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.34.0">1.34.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#2519">source</a></span><h4 class="code-header">pub fn <a href="#method.escape_default" class="fnname">escape_default</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/str/iter/struct.EscapeDefault.html" title="struct core::str::iter::EscapeDefault">EscapeDefault</a><'_></h4></section></summary><div class="docblock"><p>Return an iterator that escapes each char in <code>self</code> with <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html#method.escape_default" title="char::escape_default"><code>char::escape_default</code></a>.</p>
|
||
<h5 id="examples-58"><a href="#examples-58">Examples</a></h5>
|
||
<p>As an iterator:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">for </span>c <span class="kw">in </span><span class="string">"โค\n!"</span>.escape_default() {
|
||
<span class="macro">print!</span>(<span class="string">"{c}"</span>);
|
||
}
|
||
<span class="macro">println!</span>();</code></pre></div>
|
||
<p>Using <code>println!</code> directly:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"{}"</span>, <span class="string">"โค\n!"</span>.escape_default());</code></pre></div>
|
||
<p>Both are equivalent to:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"\\u{{2764}}\\n!"</span>);</code></pre></div>
|
||
<p>Using <code>to_string</code>:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">assert_eq!</span>(<span class="string">"โค\n!"</span>.escape_default().to_string(), <span class="string">"\\u{2764}\\n!"</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.escape_unicode" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.34.0">1.34.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/str/mod.rs.html#2557">source</a></span><h4 class="code-header">pub fn <a href="#method.escape_unicode" class="fnname">escape_unicode</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/str/iter/struct.EscapeUnicode.html" title="struct core::str::iter::EscapeUnicode">EscapeUnicode</a><'_></h4></section></summary><div class="docblock"><p>Return an iterator that escapes each char in <code>self</code> with <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html#method.escape_unicode" title="char::escape_unicode"><code>char::escape_unicode</code></a>.</p>
|
||
<h5 id="examples-59"><a href="#examples-59">Examples</a></h5>
|
||
<p>As an iterator:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">for </span>c <span class="kw">in </span><span class="string">"โค\n!"</span>.escape_unicode() {
|
||
<span class="macro">print!</span>(<span class="string">"{c}"</span>);
|
||
}
|
||
<span class="macro">println!</span>();</code></pre></div>
|
||
<p>Using <code>println!</code> directly:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"{}"</span>, <span class="string">"โค\n!"</span>.escape_unicode());</code></pre></div>
|
||
<p>Both are equivalent to:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"\\u{{2764}}\\u{{a}}\\u{{21}}"</span>);</code></pre></div>
|
||
<p>Using <code>to_string</code>:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">assert_eq!</span>(<span class="string">"โค\n!"</span>.escape_unicode().to_string(), <span class="string">"\\u{2764}\\u{a}\\u{21}"</span>);</code></pre></div>
|
||
</div></details></div><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.replace" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/alloc/str.rs.html#271">source</a></span><h4 class="code-header">pub fn <a href="#method.replace" class="fnname">replace</a><'a, P>(&'a self, from: P, to: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a><span class="where fmt-newline">where<br> P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.Pattern.html" title="trait core::str::pattern::Pattern">Pattern</a><'a>,</span></h4></section></summary><div class="docblock"><p>Replaces all matches of a pattern with another string.</p>
|
||
<p><code>replace</code> creates a new <a href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="String"><code>String</code></a>, and copies the data from this string slice into it.
|
||
While doing so, it attempts to find matches of a pattern. If it finds any, it
|
||
replaces them with the replacement string slice.</p>
|
||
<h5 id="examples-60"><a href="#examples-60">Examples</a></h5>
|
||
<p>Basic usage:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>s = <span class="string">"this is old"</span>;
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="string">"this is new"</span>, s.replace(<span class="string">"old"</span>, <span class="string">"new"</span>));
|
||
<span class="macro">assert_eq!</span>(<span class="string">"than an old"</span>, s.replace(<span class="string">"is"</span>, <span class="string">"an"</span>));</code></pre></div>
|
||
<p>When the pattern doesnโt match:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>s = <span class="string">"this is old"</span>;
|
||
<span class="macro">assert_eq!</span>(s, s.replace(<span class="string">"cookie monster"</span>, <span class="string">"little lamb"</span>));</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.replacen" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.16.0">1.16.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/alloc/str.rs.html#311">source</a></span><h4 class="code-header">pub fn <a href="#method.replacen" class="fnname">replacen</a><'a, P>(&'a self, pat: P, to: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, count: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a><span class="where fmt-newline">where<br> P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/str/pattern/trait.Pattern.html" title="trait core::str::pattern::Pattern">Pattern</a><'a>,</span></h4></section></summary><div class="docblock"><p>Replaces first N matches of a pattern with another string.</p>
|
||
<p><code>replacen</code> creates a new <a href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="String"><code>String</code></a>, and copies the data from this string slice into it.
|
||
While doing so, it attempts to find matches of a pattern. If it finds any, it
|
||
replaces them with the replacement string slice at most <code>count</code> times.</p>
|
||
<h5 id="examples-61"><a href="#examples-61">Examples</a></h5>
|
||
<p>Basic usage:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>s = <span class="string">"foo foo 123 foo"</span>;
|
||
<span class="macro">assert_eq!</span>(<span class="string">"new new 123 foo"</span>, s.replacen(<span class="string">"foo"</span>, <span class="string">"new"</span>, <span class="number">2</span>));
|
||
<span class="macro">assert_eq!</span>(<span class="string">"faa fao 123 foo"</span>, s.replacen(<span class="string">'o'</span>, <span class="string">"a"</span>, <span class="number">3</span>));
|
||
<span class="macro">assert_eq!</span>(<span class="string">"foo foo new23 foo"</span>, s.replacen(char::is_numeric, <span class="string">"new"</span>, <span class="number">1</span>));</code></pre></div>
|
||
<p>When the pattern doesnโt match:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>s = <span class="string">"this is old"</span>;
|
||
<span class="macro">assert_eq!</span>(s, s.replacen(<span class="string">"cookie monster"</span>, <span class="string">"little lamb"</span>, <span class="number">10</span>));</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.to_lowercase" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.2.0">1.2.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/alloc/str.rs.html#368">source</a></span><h4 class="code-header">pub fn <a href="#method.to_lowercase" class="fnname">to_lowercase</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></h4></section></summary><div class="docblock"><p>Returns the lowercase equivalent of this string slice, as a new <a href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="String"><code>String</code></a>.</p>
|
||
<p>โLowercaseโ is defined according to the terms of the Unicode Derived Core Property
|
||
<code>Lowercase</code>.</p>
|
||
<p>Since some characters can expand into multiple characters when changing
|
||
the case, this function returns a <a href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="String"><code>String</code></a> instead of modifying the
|
||
parameter in-place.</p>
|
||
<h5 id="examples-62"><a href="#examples-62">Examples</a></h5>
|
||
<p>Basic usage:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>s = <span class="string">"HELLO"</span>;
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="string">"hello"</span>, s.to_lowercase());</code></pre></div>
|
||
<p>A tricky example, with sigma:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>sigma = <span class="string">"ฮฃ"</span>;
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="string">"ฯ"</span>, sigma.to_lowercase());
|
||
|
||
<span class="comment">// but at the end of a word, it's ฯ, not ฯ:
|
||
</span><span class="kw">let </span>odysseus = <span class="string">"แฝฮฮฅฮฃฮฃฮฮฮฃ"</span>;
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="string">"แฝฮดฯ
ฯฯฮตฯฯ"</span>, odysseus.to_lowercase());</code></pre></div>
|
||
<p>Languages without case are not changed:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>new_year = <span class="string">"ๅๅๆฐๅนด"</span>;
|
||
|
||
<span class="macro">assert_eq!</span>(new_year, new_year.to_lowercase());</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.to_uppercase" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.2.0">1.2.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/alloc/str.rs.html#459">source</a></span><h4 class="code-header">pub fn <a href="#method.to_uppercase" class="fnname">to_uppercase</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></h4></section></summary><div class="docblock"><p>Returns the uppercase equivalent of this string slice, as a new <a href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="String"><code>String</code></a>.</p>
|
||
<p>โUppercaseโ is defined according to the terms of the Unicode Derived Core Property
|
||
<code>Uppercase</code>.</p>
|
||
<p>Since some characters can expand into multiple characters when changing
|
||
the case, this function returns a <a href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="String"><code>String</code></a> instead of modifying the
|
||
parameter in-place.</p>
|
||
<h5 id="examples-63"><a href="#examples-63">Examples</a></h5>
|
||
<p>Basic usage:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>s = <span class="string">"hello"</span>;
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="string">"HELLO"</span>, s.to_uppercase());</code></pre></div>
|
||
<p>Scripts without case are not changed:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>new_year = <span class="string">"ๅๅๆฐๅนด"</span>;
|
||
|
||
<span class="macro">assert_eq!</span>(new_year, new_year.to_uppercase());</code></pre></div>
|
||
<p>One character can become multiple:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>s = <span class="string">"tschรผร"</span>;
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="string">"TSCHรSS"</span>, s.to_uppercase());</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.repeat" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.16.0">1.16.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/alloc/str.rs.html#531">source</a></span><h4 class="code-header">pub fn <a href="#method.repeat" class="fnname">repeat</a>(&self, n: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></h4></section></summary><div class="docblock"><p>Creates a new <a href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="String"><code>String</code></a> by repeating a string <code>n</code> times.</p>
|
||
<h5 id="panics-3"><a href="#panics-3">Panics</a></h5>
|
||
<p>This function will panic if the capacity would overflow.</p>
|
||
<h5 id="examples-64"><a href="#examples-64">Examples</a></h5>
|
||
<p>Basic usage:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">assert_eq!</span>(<span class="string">"abc"</span>.repeat(<span class="number">4</span>), String::from(<span class="string">"abcabcabcabc"</span>));</code></pre></div>
|
||
<p>A panic upon overflow:</p>
|
||
|
||
<div class="example-wrap should_panic"><div class='tooltip'>โ</div><pre class="rust rust-example-rendered"><code><span class="comment">// this will panic at runtime
|
||
</span><span class="kw">let </span>huge = <span class="string">"0123456789abcdef"</span>.repeat(usize::MAX);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.to_ascii_uppercase" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.23.0">1.23.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/alloc/str.rs.html#561">source</a></span><h4 class="code-header">pub fn <a href="#method.to_ascii_uppercase" class="fnname">to_ascii_uppercase</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></h4></section></summary><div class="docblock"><p>Returns a copy of this string where each character is mapped to its
|
||
ASCII upper case equivalent.</p>
|
||
<p>ASCII letters โaโ to โzโ are mapped to โAโ to โZโ,
|
||
but non-ASCII letters are unchanged.</p>
|
||
<p>To uppercase the value in-place, use <a href="https://doc.rust-lang.org/nightly/std/primitive.str.html#method.make_ascii_uppercase"><code>make_ascii_uppercase</code></a>.</p>
|
||
<p>To uppercase ASCII characters in addition to non-ASCII characters, use
|
||
<a href="#method.to_uppercase"><code>to_uppercase</code></a>.</p>
|
||
<h5 id="examples-65"><a href="#examples-65">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>s = <span class="string">"Grรผรe, Jรผrgen โค"</span>;
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="string">"GRรผรE, JรผRGEN โค"</span>, s.to_ascii_uppercase());</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.to_ascii_lowercase" class="method has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.23.0">1.23.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/alloc/str.rs.html#594">source</a></span><h4 class="code-header">pub fn <a href="#method.to_ascii_lowercase" class="fnname">to_ascii_lowercase</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></h4></section></summary><div class="docblock"><p>Returns a copy of this string where each character is mapped to its
|
||
ASCII lower case equivalent.</p>
|
||
<p>ASCII letters โAโ to โZโ are mapped to โaโ to โzโ,
|
||
but non-ASCII letters are unchanged.</p>
|
||
<p>To lowercase the value in-place, use <a href="https://doc.rust-lang.org/nightly/std/primitive.str.html#method.make_ascii_lowercase"><code>make_ascii_lowercase</code></a>.</p>
|
||
<p>To lowercase ASCII characters in addition to non-ASCII characters, use
|
||
<a href="#method.to_lowercase"><code>to_lowercase</code></a>.</p>
|
||
<h5 id="examples-66"><a href="#examples-66">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>s = <span class="string">"Grรผรe, Jรผrgen โค"</span>;
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="string">"grรผรe, jรผrgen โค"</span>, s.to_ascii_lowercase());</code></pre></div>
|
||
</div></details></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"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-AsRef%3Cstr%3E-for-ArrayString%3CCAP%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#482-485">source</a><a href="#impl-AsRef%3Cstr%3E-for-ArrayString%3CCAP%3E" class="anchor"></a><h3 class="code-header">impl<const CAP: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>> for <a class="struct" href="struct.ArrayString.html" title="struct arrayvec::ArrayString">ArrayString</a><CAP></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.as_ref" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#484">source</a><a href="#method.as_ref" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html#tymethod.as_ref" class="fnname">as_ref</a>(&self) -> &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a></h4></section></summary><div class='docblock'>Converts this type into a shared reference of the (usually inferred) input type.</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Borrow%3Cstr%3E-for-ArrayString%3CCAP%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#477-480">source</a><a href="#impl-Borrow%3Cstr%3E-for-ArrayString%3CCAP%3E" class="anchor"></a><h3 class="code-header">impl<const CAP: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>> for <a class="struct" href="struct.ArrayString.html" title="struct arrayvec::ArrayString">ArrayString</a><CAP></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#479">source</a><a href="#method.borrow" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&self) -> &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a></h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Clone-for-ArrayString%3CCAP%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#509-519">source</a><a href="#impl-Clone-for-ArrayString%3CCAP%3E" class="anchor"></a><h3 class="code-header">impl<const CAP: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>> <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="struct.ArrayString.html" title="struct arrayvec::ArrayString">ArrayString</a><CAP></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#511-513">source</a><a href="#method.clone" class="anchor"></a><h4 class="code-header">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="struct.ArrayString.html" title="struct arrayvec::ArrayString">ArrayString</a><CAP></h4></section></summary><div class='docblock'>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone_from" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#514-518">source</a><a href="#method.clone_from" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from" class="fnname">clone_from</a>(&mut self, rhs: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self)</h4></section></summary><div class='docblock'>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Debug-for-ArrayString%3CCAP%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#487-490">source</a><a href="#impl-Debug-for-ArrayString%3CCAP%3E" class="anchor"></a><h3 class="code-header">impl<const CAP: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.ArrayString.html" title="struct arrayvec::ArrayString">ArrayString</a><CAP></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#489">source</a><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt" class="fnname">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Default-for-ArrayString%3CCAP%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#40-46">source</a><a href="#impl-Default-for-ArrayString%3CCAP%3E" class="anchor"></a><h3 class="code-header">impl<const CAP: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="struct.ArrayString.html" title="struct arrayvec::ArrayString">ArrayString</a><CAP></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.default" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#43-45">source</a><a href="#method.default" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default" class="fnname">default</a>() -> <a class="struct" href="struct.ArrayString.html" title="struct arrayvec::ArrayString">ArrayString</a><CAP></h4></section></summary><div class="docblock"><p>Return an empty <code>ArrayString</code></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Deref-for-ArrayString%3CCAP%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#422-432">source</a><a href="#impl-Deref-for-ArrayString%3CCAP%3E" class="anchor"></a><h3 class="code-header">impl<const CAP: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a> for <a class="struct" href="struct.ArrayString.html" title="struct arrayvec::ArrayString">ArrayString</a><CAP></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Target" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Target" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html#associatedtype.Target" class="associatedtype">Target</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a></h4></section></summary><div class='docblock'>The resulting type after dereferencing.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.deref" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#426-431">source</a><a href="#method.deref" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html#tymethod.deref" class="fnname">deref</a>(&self) -> &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a></h4></section></summary><div class='docblock'>Dereferences the value.</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-DerefMut-for-ArrayString%3CCAP%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#434-444">source</a><a href="#impl-DerefMut-for-ArrayString%3CCAP%3E" class="anchor"></a><h3 class="code-header">impl<const CAP: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.DerefMut.html" title="trait core::ops::deref::DerefMut">DerefMut</a> for <a class="struct" href="struct.ArrayString.html" title="struct arrayvec::ArrayString">ArrayString</a><CAP></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.deref_mut" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#437-443">source</a><a href="#method.deref_mut" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.DerefMut.html#tymethod.deref_mut" class="fnname">deref_mut</a>(&mut self) -> &mut <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a></h4></section></summary><div class='docblock'>Mutably dereferences the value.</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Display-for-ArrayString%3CCAP%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#492-495">source</a><a href="#impl-Display-for-ArrayString%3CCAP%3E" class="anchor"></a><h3 class="code-header">impl<const CAP: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> for <a class="struct" href="struct.ArrayString.html" title="struct arrayvec::ArrayString">ArrayString</a><CAP></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.fmt-1" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#494">source</a><a href="#method.fmt-1" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html#tymethod.fmt" class="fnname">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html#tymethod.fmt">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-FromStr-for-ArrayString%3CCAP%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#561-568">source</a><a href="#impl-FromStr-for-ArrayString%3CCAP%3E" class="anchor"></a><h3 class="code-header">impl<const CAP: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/str/traits/trait.FromStr.html" title="trait core::str::traits::FromStr">FromStr</a> for <a class="struct" href="struct.ArrayString.html" title="struct arrayvec::ArrayString">ArrayString</a><CAP></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Err" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Err" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/nightly/core/str/traits/trait.FromStr.html#associatedtype.Err" class="associatedtype">Err</a> = <a class="struct" href="struct.CapacityError.html" title="struct arrayvec::CapacityError">CapacityError</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></h4></section></summary><div class='docblock'>The associated error which can be returned from parsing.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from_str" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#565-567">source</a><a href="#method.from_str" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/str/traits/trait.FromStr.html#tymethod.from_str" class="fnname">from_str</a>(s: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, Self::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/str/traits/trait.FromStr.html#associatedtype.Err" title="type core::str::traits::FromStr::Err">Err</a>></h4></section></summary><div class='docblock'>Parses a string <code>s</code> to return a value of this type. <a href="https://doc.rust-lang.org/nightly/core/str/traits/trait.FromStr.html#tymethod.from_str">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Hash-for-ArrayString%3CCAP%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#470-475">source</a><a href="#impl-Hash-for-ArrayString%3CCAP%3E" class="anchor"></a><h3 class="code-header">impl<const CAP: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> for <a class="struct" href="struct.ArrayString.html" title="struct arrayvec::ArrayString">ArrayString</a><CAP></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.hash" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#472-474">source</a><a href="#method.hash" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html#tymethod.hash" class="fnname">hash</a><H: <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hasher.html" title="trait core::hash::Hasher">Hasher</a>>(&self, h: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>H)</h4></section></summary><div class='docblock'>Feeds this value into the given <a href="https://doc.rust-lang.org/nightly/core/hash/trait.Hasher.html" title="Hasher"><code>Hasher</code></a>. <a href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html#tymethod.hash">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.hash_slice" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.3.0">1.3.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/hash/mod.rs.html#237-239">source</a></span><a href="#method.hash_slice" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html#method.hash_slice" class="fnname">hash_slice</a><H>(data: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[Self]</a>, state: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>H)<span class="where fmt-newline">where<br> H: <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hasher.html" title="trait core::hash::Hasher">Hasher</a>,<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</span></h4></section></summary><div class='docblock'>Feeds a slice of this type into the given <a href="https://doc.rust-lang.org/nightly/core/hash/trait.Hasher.html" title="Hasher"><code>Hasher</code></a>. <a href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html#method.hash_slice">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Ord-for-ArrayString%3CCAP%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#554-559">source</a><a href="#impl-Ord-for-ArrayString%3CCAP%3E" class="anchor"></a><h3 class="code-header">impl<const CAP: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html" title="trait core::cmp::Ord">Ord</a> for <a class="struct" href="struct.ArrayString.html" title="struct arrayvec::ArrayString">ArrayString</a><CAP></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.cmp" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#556-558">source</a><a href="#method.cmp" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html#tymethod.cmp" class="fnname">cmp</a>(&self, rhs: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/cmp/enum.Ordering.html" title="enum core::cmp::Ordering">Ordering</a></h4></section></summary><div class='docblock'>This method returns an <a href="https://doc.rust-lang.org/nightly/core/cmp/enum.Ordering.html" title="Ordering"><code>Ordering</code></a> between <code>self</code> and <code>other</code>. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html#tymethod.cmp">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.max" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.21.0">1.21.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#795-798">source</a></span><a href="#method.max" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html#method.max" class="fnname">max</a>(self, other: Self) -> Self<span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</span></h4></section></summary><div class='docblock'>Compares and returns the maximum of two values. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html#method.max">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.min" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.21.0">1.21.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#822-825">source</a></span><a href="#method.min" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html#method.min" class="fnname">min</a>(self, other: Self) -> Self<span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</span></h4></section></summary><div class='docblock'>Compares and returns the minimum of two values. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html#method.min">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clamp" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.50.0">1.50.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#854-858">source</a></span><a href="#method.clamp" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html#method.clamp" class="fnname">clamp</a>(self, min: Self, max: Self) -> Self<span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html" title="trait core::cmp::PartialOrd">PartialOrd</a><Self>,</span></h4></section></summary><div class='docblock'>Restrict a value to a certain interval. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html#method.clamp">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-PartialEq%3CArrayString%3CCAP%3E%3E-for-ArrayString%3CCAP%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#446-451">source</a><a href="#impl-PartialEq%3CArrayString%3CCAP%3E%3E-for-ArrayString%3CCAP%3E" class="anchor"></a><h3 class="code-header">impl<const CAP: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a><<a class="struct" href="struct.ArrayString.html" title="struct arrayvec::ArrayString">ArrayString</a><CAP>> for <a class="struct" href="struct.ArrayString.html" title="struct arrayvec::ArrayString">ArrayString</a><CAP></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.eq" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#448-450">source</a><a href="#method.eq" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq" class="fnname">eq</a>(&self, rhs: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used
|
||
by <code>==</code>. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.ne" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#227">source</a></span><a href="#method.ne" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne" class="fnname">ne</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Rhs) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>This method tests for <code>!=</code>. The default implementation is almost always
|
||
sufficient, and should not be overridden without very good reason. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-PartialEq%3CArrayString%3CCAP%3E%3E-for-str" class="impl has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#460-465">source</a><a href="#impl-PartialEq%3CArrayString%3CCAP%3E%3E-for-str" class="anchor"></a><h3 class="code-header">impl<const CAP: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a><<a class="struct" href="struct.ArrayString.html" title="struct arrayvec::ArrayString">ArrayString</a><CAP>> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.eq-2" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#462-464">source</a><a href="#method.eq-2" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq" class="fnname">eq</a>(&self, rhs: &<a class="struct" href="struct.ArrayString.html" title="struct arrayvec::ArrayString">ArrayString</a><CAP>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used
|
||
by <code>==</code>. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.ne-2" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#227">source</a></span><a href="#method.ne-2" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne" class="fnname">ne</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Rhs) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>This method tests for <code>!=</code>. The default implementation is almost always
|
||
sufficient, and should not be overridden without very good reason. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-PartialEq%3Cstr%3E-for-ArrayString%3CCAP%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#453-458">source</a><a href="#impl-PartialEq%3Cstr%3E-for-ArrayString%3CCAP%3E" class="anchor"></a><h3 class="code-header">impl<const CAP: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>> for <a class="struct" href="struct.ArrayString.html" title="struct arrayvec::ArrayString">ArrayString</a><CAP></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.eq-1" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#455-457">source</a><a href="#method.eq-1" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq" class="fnname">eq</a>(&self, rhs: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used
|
||
by <code>==</code>. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.ne-1" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#227">source</a></span><a href="#method.ne-1" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne" class="fnname">ne</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Rhs) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>This method tests for <code>!=</code>. The default implementation is almost always
|
||
sufficient, and should not be overridden without very good reason. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-PartialOrd%3CArrayString%3CCAP%3E%3E-for-ArrayString%3CCAP%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#521-530">source</a><a href="#impl-PartialOrd%3CArrayString%3CCAP%3E%3E-for-ArrayString%3CCAP%3E" class="anchor"></a><h3 class="code-header">impl<const CAP: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html" title="trait core::cmp::PartialOrd">PartialOrd</a><<a class="struct" href="struct.ArrayString.html" title="struct arrayvec::ArrayString">ArrayString</a><CAP>> for <a class="struct" href="struct.ArrayString.html" title="struct arrayvec::ArrayString">ArrayString</a><CAP></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.partial_cmp" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#523-525">source</a><a href="#method.partial_cmp" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#tymethod.partial_cmp" class="fnname">partial_cmp</a>(&self, rhs: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/cmp/enum.Ordering.html" title="enum core::cmp::Ordering">Ordering</a>></h4></section></summary><div class='docblock'>This method returns an ordering between <code>self</code> and <code>other</code> values if one exists. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#tymethod.partial_cmp">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.lt" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#526">source</a><a href="#method.lt" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.lt" class="fnname">lt</a>(&self, rhs: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>This method tests less than (for <code>self</code> and <code>other</code>) and is used by the <code><</code> operator. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.lt">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.le" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#527">source</a><a href="#method.le" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.le" class="fnname">le</a>(&self, rhs: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>This method tests less than or equal to (for <code>self</code> and <code>other</code>) and is used by the <code><=</code>
|
||
operator. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.le">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.gt" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#528">source</a><a href="#method.gt" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.gt" class="fnname">gt</a>(&self, rhs: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>This method tests greater than (for <code>self</code> and <code>other</code>) and is used by the <code>></code> operator. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.gt">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.ge" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#529">source</a><a href="#method.ge" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.ge" class="fnname">ge</a>(&self, rhs: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>This method tests greater than or equal to (for <code>self</code> and <code>other</code>) and is used by the <code>>=</code>
|
||
operator. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.ge">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-PartialOrd%3CArrayString%3CCAP%3E%3E-for-str" class="impl has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#543-552">source</a><a href="#impl-PartialOrd%3CArrayString%3CCAP%3E%3E-for-str" class="anchor"></a><h3 class="code-header">impl<const CAP: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html" title="trait core::cmp::PartialOrd">PartialOrd</a><<a class="struct" href="struct.ArrayString.html" title="struct arrayvec::ArrayString">ArrayString</a><CAP>> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.partial_cmp-2" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#545-547">source</a><a href="#method.partial_cmp-2" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#tymethod.partial_cmp" class="fnname">partial_cmp</a>(&self, rhs: &<a class="struct" href="struct.ArrayString.html" title="struct arrayvec::ArrayString">ArrayString</a><CAP>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/cmp/enum.Ordering.html" title="enum core::cmp::Ordering">Ordering</a>></h4></section></summary><div class='docblock'>This method returns an ordering between <code>self</code> and <code>other</code> values if one exists. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#tymethod.partial_cmp">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.lt-2" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#548">source</a><a href="#method.lt-2" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.lt" class="fnname">lt</a>(&self, rhs: &<a class="struct" href="struct.ArrayString.html" title="struct arrayvec::ArrayString">ArrayString</a><CAP>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>This method tests less than (for <code>self</code> and <code>other</code>) and is used by the <code><</code> operator. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.lt">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.le-2" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#549">source</a><a href="#method.le-2" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.le" class="fnname">le</a>(&self, rhs: &<a class="struct" href="struct.ArrayString.html" title="struct arrayvec::ArrayString">ArrayString</a><CAP>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>This method tests less than or equal to (for <code>self</code> and <code>other</code>) and is used by the <code><=</code>
|
||
operator. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.le">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.gt-2" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#550">source</a><a href="#method.gt-2" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.gt" class="fnname">gt</a>(&self, rhs: &<a class="struct" href="struct.ArrayString.html" title="struct arrayvec::ArrayString">ArrayString</a><CAP>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>This method tests greater than (for <code>self</code> and <code>other</code>) and is used by the <code>></code> operator. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.gt">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.ge-2" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#551">source</a><a href="#method.ge-2" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.ge" class="fnname">ge</a>(&self, rhs: &<a class="struct" href="struct.ArrayString.html" title="struct arrayvec::ArrayString">ArrayString</a><CAP>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>This method tests greater than or equal to (for <code>self</code> and <code>other</code>) and is used by the <code>>=</code>
|
||
operator. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.ge">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-PartialOrd%3Cstr%3E-for-ArrayString%3CCAP%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#532-541">source</a><a href="#impl-PartialOrd%3Cstr%3E-for-ArrayString%3CCAP%3E" class="anchor"></a><h3 class="code-header">impl<const CAP: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html" title="trait core::cmp::PartialOrd">PartialOrd</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>> for <a class="struct" href="struct.ArrayString.html" title="struct arrayvec::ArrayString">ArrayString</a><CAP></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.partial_cmp-1" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#534-536">source</a><a href="#method.partial_cmp-1" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#tymethod.partial_cmp" class="fnname">partial_cmp</a>(&self, rhs: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/cmp/enum.Ordering.html" title="enum core::cmp::Ordering">Ordering</a>></h4></section></summary><div class='docblock'>This method returns an ordering between <code>self</code> and <code>other</code> values if one exists. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#tymethod.partial_cmp">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.lt-1" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#537">source</a><a href="#method.lt-1" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.lt" class="fnname">lt</a>(&self, rhs: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>This method tests less than (for <code>self</code> and <code>other</code>) and is used by the <code><</code> operator. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.lt">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.le-1" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#538">source</a><a href="#method.le-1" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.le" class="fnname">le</a>(&self, rhs: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>This method tests less than or equal to (for <code>self</code> and <code>other</code>) and is used by the <code><=</code>
|
||
operator. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.le">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.gt-1" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#539">source</a><a href="#method.gt-1" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.gt" class="fnname">gt</a>(&self, rhs: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>This method tests greater than (for <code>self</code> and <code>other</code>) and is used by the <code>></code> operator. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.gt">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.ge-1" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#540">source</a><a href="#method.ge-1" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.ge" class="fnname">ge</a>(&self, rhs: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>This method tests greater than or equal to (for <code>self</code> and <code>other</code>) and is used by the <code>>=</code>
|
||
operator. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.ge">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-TryFrom%3C%26%27a%20str%3E-for-ArrayString%3CCAP%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#619-628">source</a><a href="#impl-TryFrom%3C%26%27a%20str%3E-for-ArrayString%3CCAP%3E" class="anchor"></a><h3 class="code-header">impl<'a, const CAP: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><&'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>> for <a class="struct" href="struct.ArrayString.html" title="struct arrayvec::ArrayString">ArrayString</a><CAP></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="struct" href="struct.CapacityError.html" title="struct arrayvec::CapacityError">CapacityError</a><&'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#623-627">source</a><a href="#method.try_from" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from" class="fnname">try_from</a>(f: &'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, Self::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-TryFrom%3CArguments%3C%27a%3E%3E-for-ArrayString%3CCAP%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#630-640">source</a><a href="#impl-TryFrom%3CArguments%3C%27a%3E%3E-for-ArrayString%3CCAP%3E" class="anchor"></a><h3 class="code-header">impl<'a, const CAP: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><<a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Arguments.html" title="struct core::fmt::Arguments">Arguments</a><'a>> for <a class="struct" href="struct.ArrayString.html" title="struct arrayvec::ArrayString">ArrayString</a><CAP></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="struct" href="struct.CapacityError.html" title="struct arrayvec::CapacityError">CapacityError</a><<a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Error.html" title="struct core::fmt::Error">Error</a>></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_from-1" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#634-639">source</a><a href="#method.try_from-1" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from" class="fnname">try_from</a>(f: <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Arguments.html" title="struct core::fmt::Arguments">Arguments</a><'a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, Self::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Write-for-ArrayString%3CCAP%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#498-507">source</a><a href="#impl-Write-for-ArrayString%3CCAP%3E" class="anchor"></a><h3 class="code-header">impl<const CAP: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Write.html" title="trait core::fmt::Write">Write</a> for <a class="struct" href="struct.ArrayString.html" title="struct arrayvec::ArrayString">ArrayString</a><CAP></h3></section></summary><div class="docblock"><p><code>Write</code> appends written data to the end of the string.</p>
|
||
</div><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.write_char" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#500-502">source</a><a href="#method.write_char" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Write.html#method.write_char" class="fnname">write_char</a>(&mut self, c: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.char.html">char</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'>Writes a <a href="https://doc.rust-lang.org/nightly/std/primitive.char.html" title="char"><code>char</code></a> into this writer, returning whether the write succeeded. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Write.html#method.write_char">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.write_str" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#504-506">source</a><a href="#method.write_str" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Write.html#tymethod.write_str" class="fnname">write_str</a>(&mut self, s: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'>Writes a string slice into this writer, returning whether the write
|
||
succeeded. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Write.html#tymethod.write_str">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.write_fmt" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/fmt/mod.rs.html#191">source</a></span><a href="#method.write_fmt" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Write.html#method.write_fmt" class="fnname">write_fmt</a>(&mut self, args: <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Arguments.html" title="struct core::fmt::Arguments">Arguments</a><'_>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Error.html" title="struct core::fmt::Error">Error</a>></h4></section></summary><div class='docblock'>Glue for usage of the <a href="https://doc.rust-lang.org/nightly/core/macro.write.html" title="write!"><code>write!</code></a> macro with implementors of this trait. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Write.html#method.write_fmt">Read more</a></div></details></div></details><section id="impl-Copy-for-ArrayString%3CCAP%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#33">source</a><a href="#impl-Copy-for-ArrayString%3CCAP%3E" class="anchor"></a><h3 class="code-header">impl<const CAP: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> for <a class="struct" href="struct.ArrayString.html" title="struct arrayvec::ArrayString">ArrayString</a><CAP></h3></section><section id="impl-Eq-for-ArrayString%3CCAP%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/arrayvec/array_string.rs.html#467-468">source</a><a href="#impl-Eq-for-ArrayString%3CCAP%3E" class="anchor"></a><h3 class="code-header">impl<const CAP: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> for <a class="struct" href="struct.ArrayString.html" title="struct arrayvec::ArrayString">ArrayString</a><CAP></h3></section></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><section id="impl-RefUnwindSafe-for-ArrayString%3CCAP%3E" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-ArrayString%3CCAP%3E" class="anchor"></a><h3 class="code-header">impl<const CAP: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.ArrayString.html" title="struct arrayvec::ArrayString">ArrayString</a><CAP></h3></section><section id="impl-Send-for-ArrayString%3CCAP%3E" class="impl has-srclink"><a href="#impl-Send-for-ArrayString%3CCAP%3E" class="anchor"></a><h3 class="code-header">impl<const CAP: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.ArrayString.html" title="struct arrayvec::ArrayString">ArrayString</a><CAP></h3></section><section id="impl-Sync-for-ArrayString%3CCAP%3E" class="impl has-srclink"><a href="#impl-Sync-for-ArrayString%3CCAP%3E" class="anchor"></a><h3 class="code-header">impl<const CAP: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.ArrayString.html" title="struct arrayvec::ArrayString">ArrayString</a><CAP></h3></section><section id="impl-Unpin-for-ArrayString%3CCAP%3E" class="impl has-srclink"><a href="#impl-Unpin-for-ArrayString%3CCAP%3E" class="anchor"></a><h3 class="code-header">impl<const CAP: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.ArrayString.html" title="struct arrayvec::ArrayString">ArrayString</a><CAP></h3></section><section id="impl-UnwindSafe-for-ArrayString%3CCAP%3E" class="impl has-srclink"><a href="#impl-UnwindSafe-for-ArrayString%3CCAP%3E" class="anchor"></a><h3 class="code-header">impl<const CAP: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.ArrayString.html" title="struct arrayvec::ArrayString">ArrayString</a><CAP></h3></section></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Any-for-ArrayString%3CCAP%3E" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#200">source</a><a href="#impl-Any-for-ArrayString%3CCAP%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T<span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#201">source</a><a href="#method.type_id" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id" class="fnname">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-ArrayString%3CCAP%3E" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#211">source</a><a href="#impl-Borrow%3CT%3E-for-ArrayString%3CCAP%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T<span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow-1" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#213">source</a></span><a href="#method.borrow-1" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-ArrayString%3CCAP%3E" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#220">source</a><a href="#impl-BorrowMut%3CT%3E-for-ArrayString%3CCAP%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T<span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#221">source</a></span><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fnname">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-ArrayString%3CCAP%3E" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#733">source</a><a href="#impl-From%3CT%3E-for-ArrayString%3CCAP%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from-1" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#736">source</a></span><a href="#method.from-1" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-ArrayString%3CCAP%3E" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#717">source</a><a href="#impl-Into%3CU%3E-for-ArrayString%3CCAP%3E" class="anchor"></a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T<span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#725">source</a></span><a href="#method.into" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
|
||
<p>That is, this conversion is whatever the implementation of
|
||
<code><a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="From">From</a><T> for U</code> chooses to do.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-ToOwned-for-ArrayString%3CCAP%3E" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#82">source</a><a href="#impl-ToOwned-for-ArrayString%3CCAP%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html" title="trait alloc::borrow::ToOwned">ToOwned</a> for T<span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Owned" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Owned" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#associatedtype.Owned" class="associatedtype">Owned</a> = T</h4></section></summary><div class='docblock'>The resulting type after obtaining ownership.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.to_owned" class="method trait-impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#87">source</a><a href="#method.to_owned" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned" class="fnname">to_owned</a>(&self) -> T</h4></section></summary><div class='docblock'>Creates owned data from borrowed data, usually by cloning. <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone_into" class="method trait-impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#91">source</a><a href="#method.clone_into" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into" class="fnname">clone_into</a>(&self, target: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T)</h4></section></summary><div class='docblock'>Uses borrowed data to replace owned data, usually by cloning. <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-ToString-for-ArrayString%3CCAP%3E" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/alloc/string.rs.html#2526">source</a><a href="#impl-ToString-for-ArrayString%3CCAP%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/alloc/string/trait.ToString.html" title="trait alloc::string::ToString">ToString</a> for T<span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.to_string" class="method trait-impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/alloc/string.rs.html#2532">source</a><a href="#method.to_string" class="anchor"></a><h4 class="code-header">default fn <a href="https://doc.rust-lang.org/nightly/alloc/string/trait.ToString.html#tymethod.to_string" class="fnname">to_string</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></h4></section></summary><div class='docblock'>Converts the given value to a <code>String</code>. <a href="https://doc.rust-lang.org/nightly/alloc/string/trait.ToString.html#tymethod.to_string">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-ArrayString%3CCAP%3E" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#775">source</a><a href="#impl-TryFrom%3CU%3E-for-ArrayString%3CCAP%3E" class="anchor"></a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T<span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-2" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error-2" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_from-2" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#781">source</a></span><a href="#method.try_from-2" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from" class="fnname">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-ArrayString%3CCAP%3E" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#760">source</a><a href="#impl-TryInto%3CU%3E-for-ArrayString%3CCAP%3E" class="anchor"></a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T<span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-3" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error-3" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> ยท <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#766">source</a></span><a href="#method.try_into" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into" class="fnname">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="arrayvec" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (9565dfeb4 2022-10-28)" ></div></body></html> |