<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `Pattern` trait in crate `std`."><meta name="keywords" content="rust, rustlang, rust-lang, Pattern"><title>std::str::pattern::Pattern - Rust</title><link rel="stylesheet" type="text/css" href="../../../normalize.css"><link rel="stylesheet" type="text/css" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../../dark.css"><link rel="stylesheet" type="text/css" href="../../../light.css" id="themeStyle"><script src="../../../storage.js"></script><link rel="shortcut icon" href="https://doc.rust-lang.org/favicon.ico"></head><body class="rustdoc trait"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../../std/index.html'><img src='https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png' alt='logo' width='100'></a><p class='location'>Trait Pattern</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#associated-types">Associated Types</a><div class="sidebar-links"><a href="#associatedtype.Searcher">Searcher</a></div><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.into_searcher">into_searcher</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.is_contained_in">is_contained_in</a><a href="#method.is_prefix_of">is_prefix_of</a><a href="#method.is_suffix_of">is_suffix_of</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='../../index.html'>std</a>::<wbr><a href='../index.html'>str</a>::<wbr><a href='index.html'>pattern</a></p><script>window.sidebarCurrent = {name: 'Pattern', ty: 'trait', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><a id="settings-menu" href="../../../settings.html"><img src="../../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='in-band'>Trait <a href='../../index.html'>std</a>::<wbr><a href='../index.html'>str</a>::<wbr><a href='index.html'>pattern</a>::<wbr><a class="trait" href=''>Pattern</a></span><span class='out-of-band'><span class='since' title='Stable since Rust version '></span><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../../../src/core/str/pattern.rs.html#38-71' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust trait'>pub trait Pattern<'a> {
type <a href='#associatedtype.Searcher' class="type">Searcher</a>: <a class="trait" href="../../../std/str/pattern/trait.Searcher.html" title="trait std::str::pattern::Searcher">Searcher</a><'a>;
fn <a href='#tymethod.into_searcher' class='fnname'>into_searcher</a>(self, haystack: &'a <a class="primitive" href="../../primitive.str.html">str</a>) -> Self::<a class="type" href="../../../std/str/pattern/trait.Pattern.html#associatedtype.Searcher" title="type std::str::pattern::Pattern::Searcher">Searcher</a>;
fn <a href='#method.is_contained_in' class='fnname'>is_contained_in</a>(self, haystack: &'a <a class="primitive" href="../../primitive.str.html">str</a>) -> <a class="primitive" href="../../primitive.bool.html">bool</a> { ... }
<div class='item-spacer'></div> fn <a href='#method.is_prefix_of' class='fnname'>is_prefix_of</a>(self, haystack: &'a <a class="primitive" href="../../primitive.str.html">str</a>) -> <a class="primitive" href="../../primitive.bool.html">bool</a> { ... }
<div class='item-spacer'></div> fn <a href='#method.is_suffix_of' class='fnname'>is_suffix_of</a>(self, haystack: &'a <a class="primitive" href="../../primitive.str.html">str</a>) -> <a class="primitive" href="../../primitive.bool.html">bool</a><br> <span class="where">where<br> Self::<a class="type" href="../../../std/str/pattern/trait.Pattern.html#associatedtype.Searcher" title="type std::str::pattern::Pattern::Searcher">Searcher</a>: <a class="trait" href="../../../std/str/pattern/trait.ReverseSearcher.html" title="trait std::str::pattern::ReverseSearcher">ReverseSearcher</a><'a></span>,
{ ... }
}</pre></div><div class='stability'><div class='stab unstable'><details><summary><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>pattern </code><a href="https://github.com/rust-lang/rust/issues/27721">#27721</a>)</summary><p>API not fully fleshed out and ready to be stabilized</p>
</details></div></div><div class='docblock'><p>A string pattern.</p>
<p>A <code>Pattern<'a></code> expresses that the implementing type
can be used as a string pattern for searching in a <code>&'a str</code>.</p>
<p>For example, both <code>'a'</code> and <code>"aa"</code> are patterns that
would match at index <code>1</code> in the string <code>"baaaab"</code>.</p>
<p>The trait itself acts as a builder for an associated
<code>Searcher</code> type, which does the actual work of finding
occurrences of the pattern in a string.</p>
</div>
<h2 id='associated-types' class='small-section-header'>
Associated Types<a href='#associated-types' class='anchor'></a>
</h2>
<div class='methods'>
<h3 id='associatedtype.Searcher' class='method'><span id='Searcher.t' class='invisible'><code>type <a href='#associatedtype.Searcher' class="type">Searcher</a>: <a class="trait" href="../../../std/str/pattern/trait.Searcher.html" title="trait std::str::pattern::Searcher">Searcher</a><'a></code></span></h3><div class='stability'><div class='stab unstable'><details><summary><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>pattern </code><a href="https://github.com/rust-lang/rust/issues/27721">#27721</a>)</summary><p>API not fully fleshed out and ready to be stabilized</p>
</details></div></div><div class='docblock'><p>Associated searcher for this pattern</p>
</div></div>
<h2 id='required-methods' class='small-section-header'>
Required Methods<a href='#required-methods' class='anchor'></a>
</h2>
<div class='methods'>
<h3 id='tymethod.into_searcher' class='method'><span id='into_searcher.v' class='invisible'><code>fn <a href='#tymethod.into_searcher' class='fnname'>into_searcher</a>(self, haystack: &'a <a class="primitive" href="../../primitive.str.html">str</a>) -> Self::<a class="type" href="../../../std/str/pattern/trait.Pattern.html#associatedtype.Searcher" title="type std::str::pattern::Pattern::Searcher">Searcher</a></code></span></h3><div class='stability'><div class='stab unstable'><details><summary><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>pattern </code><a href="https://github.com/rust-lang/rust/issues/27721">#27721</a>)</summary><p>API not fully fleshed out and ready to be stabilized</p>
</details></div></div><div class='docblock'><p>Constructs the associated searcher from
<code>self</code> and the <code>haystack</code> to search in.</p>
</div></div>
<h2 id='provided-methods' class='small-section-header'>
Provided Methods<a href='#provided-methods' class='anchor'></a>
</h2>
<div class='methods'>
<h3 id='method.is_contained_in' class='method'><span id='is_contained_in.v' class='invisible'><code>fn <a href='#method.is_contained_in' class='fnname'>is_contained_in</a>(self, haystack: &'a <a class="primitive" href="../../primitive.str.html">str</a>) -> <a class="primitive" href="../../primitive.bool.html">bool</a></code></span></h3><div class='stability'><div class='stab unstable'><details><summary><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>pattern </code><a href="https://github.com/rust-lang/rust/issues/27721">#27721</a>)</summary><p>API not fully fleshed out and ready to be stabilized</p>
</details></div></div><div class='docblock'><p>Checks whether the pattern matches anywhere in the haystack</p>
</div><h3 id='method.is_prefix_of' class='method'><span id='is_prefix_of.v' class='invisible'><code>fn <a href='#method.is_prefix_of' class='fnname'>is_prefix_of</a>(self, haystack: &'a <a class="primitive" href="../../primitive.str.html">str</a>) -> <a class="primitive" href="../../primitive.bool.html">bool</a></code></span></h3><div class='stability'><div class='stab unstable'><details><summary><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>pattern </code><a href="https://github.com/rust-lang/rust/issues/27721">#27721</a>)</summary><p>API not fully fleshed out and ready to be stabilized</p>
</details></div></div><div class='docblock'><p>Checks whether the pattern matches at the front of the haystack</p>
</div><h3 id='method.is_suffix_of' class='method'><span id='is_suffix_of.v' class='invisible'><code>fn <a href='#method.is_suffix_of' class='fnname'>is_suffix_of</a>(self, haystack: &'a <a class="primitive" href="../../primitive.str.html">str</a>) -> <a class="primitive" href="../../primitive.bool.html">bool</a> <span class="where fmt-newline">where<br> Self::<a class="type" href="../../../std/str/pattern/trait.Pattern.html#associatedtype.Searcher" title="type std::str::pattern::Pattern::Searcher">Searcher</a>: <a class="trait" href="../../../std/str/pattern/trait.ReverseSearcher.html" title="trait std::str::pattern::ReverseSearcher">ReverseSearcher</a><'a>, </span></code></span></h3><div class='stability'><div class='stab unstable'><details><summary><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>pattern </code><a href="https://github.com/rust-lang/rust/issues/27721">#27721</a>)</summary><p>API not fully fleshed out and ready to be stabilized</p>
</details></div></div><div class='docblock'><p>Checks whether the pattern matches at the back of the haystack</p>
</div></div>
<h2 id='implementors' class='small-section-header'>
Implementors<a href='#implementors' class='anchor'></a>
</h2>
<ul class='item-list' id='implementors-list'>
<li><table class='table-display'><tbody><tr><td><code>impl<'a> Pattern<'a> for <a class="primitive" href="../../primitive.char.html">char</a><span class="where fmt-newline"> type <a href='#associatedtype.Searcher' class="type">Searcher</a> = <a class="struct" href="../../../std/str/pattern/struct.CharSearcher.html" title="struct std::str::pattern::CharSearcher">CharSearcher</a><'a>;</span></code><td><div class='out-of-band'><a class='srclink' href='../../../src/core/str/pattern.rs.html#432-478' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
<li><table class='table-display'><tbody><tr><td><code>impl<'a, 'b> Pattern<'a> for <a class="primitive" href="../../primitive.slice.html">&'b [</a><a class="primitive" href="../../primitive.char.html">char</a><a class="primitive" href="../../primitive.slice.html">]</a><span class="where fmt-newline"> type <a href='#associatedtype.Searcher' class="type">Searcher</a> = <a class="struct" href="../../../std/str/pattern/struct.CharSliceSearcher.html" title="struct std::str::pattern::CharSliceSearcher">CharSliceSearcher</a><'a, 'b>;</span></code><td><div class='out-of-band'><a class='srclink' href='../../../src/core/str/pattern.rs.html#656-658' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
<li><table class='table-display'><tbody><tr><td><code>impl<'a, 'b, 'c> Pattern<'a> for &'c &'b <a class="primitive" href="../../primitive.str.html">str</a><span class="where fmt-newline"> type <a href='#associatedtype.Searcher' class="type">Searcher</a> = <a class="struct" href="../../../std/str/pattern/struct.StrSearcher.html" title="struct std::str::pattern::StrSearcher">StrSearcher</a><'a, 'b>;</span></code><td><div class='out-of-band'><a class='srclink' href='../../../src/core/str/pattern.rs.html#704-706' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
<li><table class='table-display'><tbody><tr><td><code>impl<'a, 'b> Pattern<'a> for &'b <a class="primitive" href="../../primitive.str.html">str</a><span class="where fmt-newline"> type <a href='#associatedtype.Searcher' class="type">Searcher</a> = <a class="struct" href="../../../std/str/pattern/struct.StrSearcher.html" title="struct std::str::pattern::StrSearcher">StrSearcher</a><'a, 'b>;</span></code><td><div class='out-of-band'><a class='srclink' href='../../../src/core/str/pattern.rs.html#716-738' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
<li><table class='table-display'><tbody><tr><td><code>impl<'a, F> Pattern<'a> for F <span class="where fmt-newline">where<br> F: <a class="trait" href="../../../std/ops/trait.FnMut.html" title="trait std::ops::FnMut">FnMut</a>(<a class="primitive" href="../../primitive.char.html">char</a>) -> <a class="primitive" href="../../primitive.bool.html">bool</a>, </span><span class="where fmt-newline"> type <a href='#associatedtype.Searcher' class="type">Searcher</a> = <a class="struct" href="../../../std/str/pattern/struct.CharPredicateSearcher.html" title="struct std::str::pattern::CharPredicateSearcher">CharPredicateSearcher</a><'a, F>;</span></code><td><div class='out-of-band'><a class='srclink' href='../../../src/core/str/pattern.rs.html#695-697' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
<li><table class='table-display'><tbody><tr><td><code>impl<'a, 'b> Pattern<'a> for &'b <a class="struct" href="../../../std/string/struct.String.html" title="struct std::string::String">String</a><span class="where fmt-newline"> type <a href='#associatedtype.Searcher' class="type">Searcher</a> = <&'b <a class="primitive" href="../../primitive.str.html">str</a> as <a class="trait" href="../../../std/str/pattern/trait.Pattern.html" title="trait std::str::pattern::Pattern">Pattern</a><'a>>::<a class="type" href="../../../std/str/pattern/trait.Pattern.html#associatedtype.Searcher" title="type std::str::pattern::Pattern::Searcher">Searcher</a>;</span></code><td><div class='out-of-band'><a class='srclink' href='../../../src/alloc/string.rs.html#1788-1804' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
</ul><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
src="../../../implementors/core/str/pattern/trait.Pattern.js">
</script></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g. <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g. <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../../";window.currentCrate = "std";</script><script src="../../../aliases.js"></script><script src="../../../main.js"></script><script defer src="../../../search-index.js"></script></body></html>
distrib
>
Mageia
>
6
>
armv7hl
>
media
>
core-updates
>
by-pkgid
>
4e2dbb669434a7691662cb2f0ad38972
>
files
>
14684
