kweepeer 0.1.2

A generic webservice for interactive query expansion, expansion is provided via various modules
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

pub mod lookup;

#[cfg(feature = "analiticcl")]
pub mod analiticcl;

#[cfg(feature = "fst")]
pub mod fst;

#[cfg(feature = "finalfusion")]
pub mod finalfusion;

use crate::lexer::Term;
use crate::{Error, QueryParams, TermExpansions};

/// This trait is implemented for all query expansions modules
pub trait Module: Send + Sync {
    /// Get the module type
    fn kind(&self) -> &'static str;

    /// Get the module identifier, some arbititrary short string
    fn id(&self) -> &str;

    /// Get the module name, a human-readable label
    fn name(&self) -> &str;

    /// Load the module. This *MUST* be called (once) prior to calling *expand_query()*.
    fn load(&mut self) -> Result<(), Error>;

    /// Expands a (decomposed) query. Note that `load()` *MUST* be called (once) prior to calling this for the first time, otherwise it will result in a panic.
    fn expand_query(
        &self,
        terms: &Vec<Term>,
        queryparams: &QueryParams,
    ) -> Result<TermExpansions, Error>;
}