blob: 224f313e52cdaa5df3c8c964b1b914c0a65733dd [file] [log] [blame]
<!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="Parallel iterator types for strings"><meta name="keywords" content="rust, rustlang, rust-lang, str"><title>rayon::str - 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="../../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 mod"><!--[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">&#9776;</button><a class="sidebar-logo" href="../../rayon/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="../../rayon/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Module str</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li></ul></section></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">Module <a href="../index.html">rayon</a>::<wbr><a class="mod" href="#">str</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/rayon/str.rs.html#1-848">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Parallel iterator types for <a href="https://doc.rust-lang.org/stable/std/str/">strings</a></p>
<p>You will rarely need to interact with this module directly unless you need
to name one of the iterator types.</p>
<p>Note: <a href="trait.ParallelString.html#method.par_split"><code>ParallelString::par_split()</code></a> and <a href="trait.ParallelString.html#method.par_split_terminator"><code>par_split_terminator()</code></a>
reference a <code>Pattern</code> trait which is not visible outside this crate.
This trait is intentionally kept private, for use only by Rayon itself.
It is implemented for <code>char</code>, <code>&amp;[char]</code>, and any function or closure
<code>F: Fn(char) -&gt; bool + Sync + Send</code>.</p>
</div></details><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Bytes.html" title="rayon::str::Bytes struct">Bytes</a></div><div class="item-right docblock-short">Parallel iterator over the bytes of a string</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.CharIndices.html" title="rayon::str::CharIndices struct">CharIndices</a></div><div class="item-right docblock-short">Parallel iterator over the characters of a string, with their positions</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Chars.html" title="rayon::str::Chars struct">Chars</a></div><div class="item-right docblock-short">Parallel iterator over the characters of a string</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.EncodeUtf16.html" title="rayon::str::EncodeUtf16 struct">EncodeUtf16</a></div><div class="item-right docblock-short">Parallel iterator over a string encoded as UTF-16</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Lines.html" title="rayon::str::Lines struct">Lines</a></div><div class="item-right docblock-short">Parallel iterator over lines in a string</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.MatchIndices.html" title="rayon::str::MatchIndices struct">MatchIndices</a></div><div class="item-right docblock-short">Parallel iterator over substrings that match a pattern, with their positions</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Matches.html" title="rayon::str::Matches struct">Matches</a></div><div class="item-right docblock-short">Parallel iterator over substrings that match a pattern</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Split.html" title="rayon::str::Split struct">Split</a></div><div class="item-right docblock-short">Parallel iterator over substrings separated by a pattern</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.SplitTerminator.html" title="rayon::str::SplitTerminator struct">SplitTerminator</a></div><div class="item-right docblock-short">Parallel iterator over substrings separated by a terminator pattern</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.SplitWhitespace.html" title="rayon::str::SplitWhitespace struct">SplitWhitespace</a></div><div class="item-right docblock-short">Parallel iterator over substrings separated by whitespace</div></div></div><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.ParallelString.html" title="rayon::str::ParallelString trait">ParallelString</a></div><div class="item-right docblock-short">Parallel extensions for strings.</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rayon" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>