<!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 `collections`."> <meta name="keywords" content="rust, rustlang, rust-lang, Pattern"> <title>collections::str::pattern::Pattern - Rust</title> <link rel="stylesheet" type="text/css" href="../../../normalize.css"> <link rel="stylesheet" type="text/css" href="../../../rustdoc.css"> <link rel="stylesheet" type="text/css" href="../../../main.css"> <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"> <a href='../../../collections/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="block items"><ul><li><a href="#associated-types">Associated Types</a></li><li><a href="#required-methods">Required Methods</a></li><li><a href="#provided-methods">Provided Methods</a></li><li><a href="#implementors">Implementors</a></li></ul></div><p class='location'><a href='../../index.html'>collections</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> </nav> <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"> </div> </form> </nav> <section id='main' class="content"> <h1 class='fqn'><span class='in-band'>Trait <a href='../../index.html'>collections</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#37-70' title='goto source code'>[src]</a></span></h1> <pre class='rust trait'>pub trait Pattern<'a> { type <a href='#associatedtype.Searcher' class="type">Searcher</a>: <a class="trait" href="../../../collections/str/pattern/trait.Searcher.html" title="trait collections::str::pattern::Searcher">Searcher</a><'a>; fn <a href='#tymethod.into_searcher' class='fnname'>into_searcher</a>(self, haystack: &'a str) -> Self::<a class="trait" href="../../../collections/str/pattern/trait.Pattern.html" title="trait collections::str::pattern::Pattern">Searcher</a>; fn <a href='#method.is_contained_in' class='fnname'>is_contained_in</a>(self, haystack: &'a str) -> bool { ... } fn <a href='#method.is_prefix_of' class='fnname'>is_prefix_of</a>(self, haystack: &'a str) -> bool { ... } fn <a href='#method.is_suffix_of' class='fnname'>is_suffix_of</a>(self, haystack: &'a str) -> bool<br> <span class="where">where<br> Self::<a class="trait" href="../../../collections/str/pattern/trait.Pattern.html" title="trait collections::str::pattern::Pattern">Searcher</a>: <a class="trait" href="../../../collections/str/pattern/trait.ReverseSearcher.html" title="trait collections::str::pattern::ReverseSearcher">ReverseSearcher</a><'a></span>, { ... } }</pre><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'>Associated Types</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="../../../collections/str/pattern/trait.Searcher.html" title="trait collections::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'>Required Methods</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 str) -> Self::<a class="trait" href="../../../collections/str/pattern/trait.Pattern.html" title="trait collections::str::pattern::Pattern">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'>Provided Methods</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 str) -> bool</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 str) -> bool</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 str) -> bool <span class="where fmt-newline">where<br> Self::<a class="trait" href="../../../collections/str/pattern/trait.Pattern.html" title="trait collections::str::pattern::Pattern">Searcher</a>: <a class="trait" href="../../../collections/str/pattern/trait.ReverseSearcher.html" title="trait collections::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'>Implementors</h2> <ul class='item-list' id='implementors-list'> <li><code>impl<'a> Pattern<'a> for char</code></li> <li><code>impl<'a, 'b> Pattern<'a> for &'b str</code></li> <li><code>impl<'a, 'b> Pattern<'a> for &'b [char]</code></li> <li><code>impl<'a, 'b, 'c> Pattern<'a> for &'c &'b str</code></li> <li><code>impl<'a, F> Pattern<'a> for F <span class="where fmt-newline">where<br> F: <a class="trait" href="../../../core/ops/trait.FnMut.html" title="trait core::ops::FnMut">FnMut</a>(char) -> bool, </span></code></li> <li><code>impl<'a, 'b> Pattern<'a> for &'b <a class="struct" href="../../../collections/string/struct.String.html" title="struct collections::string::String">String</a></code></li> </ul><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>?</dt> <dd>Show this help dialog</dd> <dt>S</dt> <dd>Focus the search field</dd> <dt>⇤</dt> <dd>Move up in search results</dd> <dt>⇥</dt> <dd>Move down in search results</dd> <dt>⏎</dt> <dd>Go to active search result</dd> <dt>+</dt> <dd>Collapse/expand 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> </div> </div> </aside> <script> window.rootPath = "../../../"; window.currentCrate = "collections"; </script> <script src="../../../main.js"></script> <script defer src="../../../search-index.js"></script> </body> </html>