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

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

use crate::{
    client::{Client, Error},
    execute_wrapper,
};
use typesense_codegen::{apis::stemming_api, models};

/// Provides methods for interacting with a specific stemming dictionary.
///
/// This struct is created by calling `client.stemming().dictionary("dictionary_id")`.
pub struct Dictionary<'a> {
    pub(super) client: &'a Client,
    pub(super) dictionary_id: &'a str,
}

impl<'a> Dictionary<'a> {
    /// Creates a new `Dictionary` instance for a specific dictionary ID.
    #[inline]
    pub(super) fn new(client: &'a Client, dictionary_id: &'a str) -> Self {
        Self {
            client,
            dictionary_id,
        }
    }

    /// Retrieves the details of this specific stemming dictionary.
    pub async fn retrieve(
        &self,
    ) -> Result<models::StemmingDictionary, Error<stemming_api::GetStemmingDictionaryError>> {
        let params = stemming_api::GetStemmingDictionaryParams {
            dictionary_id: self.dictionary_id.into(),
        };
        execute_wrapper!(self, stemming_api::get_stemming_dictionary, params)
    }
}