Struct Token 

pub struct Token {
    pub text: String,
    pub offset_from: usize,
    pub offset_to: usize,
    pub position: u32,
}

A single token produced by the analysis pipeline.

Carries the token text (possibly transformed by filters), byte offsets into the original text, and a logical position for phrase queries and proximity scoring.

See [[analyzers]].

Fields

text: String

The token text, possibly transformed by token filters.

offset_from: usize

Byte offset of the token start in the original text.

offset_to: usize

Byte offset past the token end in the original text.

position: u32

Monotonically increasing position in the token stream. Used for phrase queries and proximity scoring.

Implementations

impl Token

pub fn new( text: impl Into<String>, offset_from: usize, offset_to: usize, position: u32, ) -> Self

Create a new token with the given text, offsets, and position.

Trait Implementations

impl Clone for Token

fn clone(&self) -> Token

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Token

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for Token

impl PartialEq for Token

fn eq(&self, other: &Token) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Token