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
41
42

//! Provides access to the API endpoints for managing a single preset.
//!
//! A `Preset` instance is created via the main `client.preset("preset_id")` method.

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

/// Provides methods for managing a single Typesense preset.
///
/// This struct is created by calling `client.preset("preset_id")`.
pub struct Preset<'a> {
    pub(super) client: &'a Client,
    pub(super) preset_id: &'a str,
}

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

    /// Retrieves the details of a preset, given its Id.
    pub async fn retrieve(
        &self,
    ) -> Result<models::PresetSchema, Error<presets_api::RetrievePresetError>> {
        let params = presets_api::RetrievePresetParams {
            preset_id: self.preset_id.into(),
        };
        execute_wrapper!(self, presets_api::retrieve_preset, params)
    }

    /// Permanently deletes a preset, given its Id.
    pub async fn delete(
        &self,
    ) -> Result<models::PresetDeleteSchema, Error<presets_api::DeletePresetError>> {
        let params = presets_api::DeletePresetParams {
            preset_id: self.preset_id.into(),
        };
        execute_wrapper!(self, presets_api::delete_preset, params)
    }
}