| <!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="Trait for the pluggable components of `Tokenizer`s."><meta name="keywords" content="rust, rustlang, rust-lang, TokenFilter"><title>TokenFilter in tantivy::tokenizer - 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 trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../tantivy/index.html"><div class="logo-container"><img src="http://fulmicoton.com/tantivy-logo/tantivy-logo.png" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../tantivy/index.html"><div class="logo-container"> |
| <img src="http://fulmicoton.com/tantivy-logo/tantivy-logo.png" alt="logo"></div></a><h2 class="location"><a href="#">TokenFilter</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.transform">transform</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In tantivy::tokenizer</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">Trait <a href="../index.html">tantivy</a>::<wbr><a href="index.html">tokenizer</a>::<wbr><a class="trait" href="#">TokenFilter</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/tantivy/tokenizer/tokenizer.rs.html#280-283">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 trait"><code>pub trait TokenFilter: 'static + Send + Sync + TokenFilterClone { |
| fn <a href="#tymethod.transform" class="fnname">transform</a><'a>(<br> &self,<br> token_stream: <a class="struct" href="struct.BoxTokenStream.html" title="struct tantivy::tokenizer::BoxTokenStream">BoxTokenStream</a><'a><br> ) -> <a class="struct" href="struct.BoxTokenStream.html" title="struct tantivy::tokenizer::BoxTokenStream">BoxTokenStream</a><'a>; |
| }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Trait for the pluggable components of <code>Tokenizer</code>s.</p> |
| </div></details><h2 id="required-methods" class="small-section-header">Required Methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.transform" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/tokenizer/tokenizer.rs.html#282">source</a><h4 class="code-header">fn <a href="#tymethod.transform" class="fnname">transform</a><'a>(&self, token_stream: <a class="struct" href="struct.BoxTokenStream.html" title="struct tantivy::tokenizer::BoxTokenStream">BoxTokenStream</a><'a>) -> <a class="struct" href="struct.BoxTokenStream.html" title="struct tantivy::tokenizer::BoxTokenStream">BoxTokenStream</a><'a></h4></section></summary><div class="docblock"><p>Wraps a token stream and returns the modified one.</p> |
| </div></details></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div id="implementors-list"><section id="impl-TokenFilter-for-AlphaNumOnlyFilter" class="impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/tokenizer/alphanum_only.rs.html#39-43">source</a><a href="#impl-TokenFilter-for-AlphaNumOnlyFilter" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.TokenFilter.html" title="trait tantivy::tokenizer::TokenFilter">TokenFilter</a> for <a class="struct" href="struct.AlphaNumOnlyFilter.html" title="struct tantivy::tokenizer::AlphaNumOnlyFilter">AlphaNumOnlyFilter</a></h3></section><section id="impl-TokenFilter-for-AsciiFoldingFilter" class="impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/tokenizer/ascii_folding_filter.rs.html#11-18">source</a><a href="#impl-TokenFilter-for-AsciiFoldingFilter" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.TokenFilter.html" title="trait tantivy::tokenizer::TokenFilter">TokenFilter</a> for <a class="struct" href="struct.AsciiFoldingFilter.html" title="struct tantivy::tokenizer::AsciiFoldingFilter">AsciiFoldingFilter</a></h3></section><section id="impl-TokenFilter-for-LowerCaser" class="impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/tokenizer/lower_caser.rs.html#6-13">source</a><a href="#impl-TokenFilter-for-LowerCaser" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.TokenFilter.html" title="trait tantivy::tokenizer::TokenFilter">TokenFilter</a> for <a class="struct" href="struct.LowerCaser.html" title="struct tantivy::tokenizer::LowerCaser">LowerCaser</a></h3></section><section id="impl-TokenFilter-for-RemoveLongFilter" class="impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/tokenizer/remove_long.rs.html#40-47">source</a><a href="#impl-TokenFilter-for-RemoveLongFilter" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.TokenFilter.html" title="trait tantivy::tokenizer::TokenFilter">TokenFilter</a> for <a class="struct" href="struct.RemoveLongFilter.html" title="struct tantivy::tokenizer::RemoveLongFilter">RemoveLongFilter</a></h3></section><section id="impl-TokenFilter-for-Stemmer" class="impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/tokenizer/stemmer.rs.html#84-93">source</a><a href="#impl-TokenFilter-for-Stemmer" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.TokenFilter.html" title="trait tantivy::tokenizer::TokenFilter">TokenFilter</a> for <a class="struct" href="struct.Stemmer.html" title="struct tantivy::tokenizer::Stemmer">Stemmer</a></h3></section><section id="impl-TokenFilter-for-StopWordFilter" class="impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/tokenizer/stop_word_filter/mod.rs.html#75-82">source</a><a href="#impl-TokenFilter-for-StopWordFilter" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.TokenFilter.html" title="trait tantivy::tokenizer::TokenFilter">TokenFilter</a> for <a class="struct" href="struct.StopWordFilter.html" title="struct tantivy::tokenizer::StopWordFilter">StopWordFilter</a></h3></section><section id="impl-TokenFilter-for-SplitCompoundWords%3CS%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/tokenizer/split_compound_words.rs.html#78-87">source</a><a href="#impl-TokenFilter-for-SplitCompoundWords%3CS%3E" class="anchor"></a><h3 class="code-header">impl<S: <a class="trait" href="../../aho_corasick/state_id/trait.StateID.html" title="trait aho_corasick::state_id::StateID">StateID</a> + Send + Sync + 'static> <a class="trait" href="trait.TokenFilter.html" title="trait tantivy::tokenizer::TokenFilter">TokenFilter</a> for <a class="struct" href="struct.SplitCompoundWords.html" title="struct tantivy::tokenizer::SplitCompoundWords">SplitCompoundWords</a><S></h3></section></div><script src="../../implementors/tantivy/tokenizer/tokenizer/trait.TokenFilter.js" async></script></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="tantivy" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
