typesense 0.4.0

Client for typesense
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
36
37
38
39
40

//! Provides access to the API endpoints for managing stemming.
//!
//! An instance of `Stemming` is created via the `client.stemming()` method.

pub mod dictionaries;
pub mod dictionary;

use super::Client;
use dictionaries::Dictionaries;
use dictionary::Dictionary;

/// Provides methods for managing Typesense stemming.
///
/// This struct is created by calling `client.stemming()`.
pub struct Stemming<'a> {
    pub(super) client: &'a Client,
}

impl<'a> Stemming<'a> {
    /// Creates a new `Stemming` instance.
    #[inline]
    pub(super) fn new(client: &'a Client) -> Self {
        Self { client }
    }

    /// Provides access to endpoints for managing the collection of dictionaries.
    #[inline]
    pub fn dictionaries(&self) -> Dictionaries<'a> {
        Dictionaries::new(self.client)
    }

    /// Provides access to endpoints for managing a single dictionary.
    ///
    /// # Arguments
    /// * `dictionary_id` - The ID of the dictionary to manage.
    #[inline]
    pub fn dictionary(&self, dictionary_id: &'a str) -> Dictionary<'a> {
        Dictionary::new(self.client, dictionary_id)
    }
}