Struct Analyze

pub struct Analyze { /* private fields */ }

Performs analysis on a text string and returns the resulting tokens. The basic analyze:

To analyze with custom analyzer:

let custom_analyzer = CustomAnalyzer::new("whitespace")
   .filter([
       StringOrObject::String("lowercase".to_string()),
       StringOrObject::Object(json!({"type": "stop", "stopwords": ["a", "is", "this"]})),
   ]);
let test = Analyze::new(["test this text", "and this one please"])
   .analyzer(custom_analyzer)
   .explain(true)
   .attributes(["attributes"]);

To analyze custom normalizer:

let custom_normalizer = CustomNormalizer::new()
   .char_filter([
       json!({ "type": "mapping", "mappings": ["٠ => 0", "١ => 1", "٢ => 2"] }),
   ])
   .filter(["snowball"]);
let test = Analyze::new(["test this text", "and this one please"])
   .analyzer(custom_normalizer)
   .explain(true)
   .attributes(["attributes"]);

Implementations

impl Analyze

pub fn new<S>(text: S) -> Self

where S: Into<StringOrVecString>,

Creates an instance of Analyze

• text - Text to analyze. If an array of strings is provided, it is analyzed as a multi-value field.

pub fn analyzer<S>(self, analyzer: S) -> Self

where S: Into<Analysis>,

Specify an analyzer, either it’s built-in analyzer, custom analyzer, built-in normalizer, custom normalizer or field

pub fn attributes<I>(self, attributes: I) -> Self

where I: IntoIterator, I::Item: ToString,

Array of token attributes used to filter the output of the explain parameter.

pub fn explain(self, explain: bool) -> Self

If true, the response includes token attributes and additional details. Defaults to false. experimental

Trait Implementations

impl Clone for Analyze

fn clone(&self) -> Analyze

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Analyze

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

Formats the value using the given formatter.

impl Default for Analyze

fn default() -> Analyze

Returns the “default value” for a type.

impl PartialEq for Analyze

fn eq(&self, other: &Analyze) -> 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 Serialize for Analyze

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Analyze

impl StructuralPartialEq for Analyze