storage-kit 0.0.1

Portable database and transactional state-store Kit.
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
43
44
45
46
47
48
49
50
51
52
53
54

use serde::{Deserialize, Serialize};

use crate::StorageLocator;
use crate::core::ApplyDefaultLocator;

use super::{ScopedQuery, TextQueryOptions};
/// Request to run a full-text search.
///
/// # Examples
///
/// ```
/// let request = storage_kit::database::query::TextSearchRequest {
///     query: storage_kit::database::query::ScopedQuery::text(storage_kit::database::StorageLocator::new("documents"))
///         .text_field("body")
///         .limit(10),
///     text: "rust storage".into(),
/// };
/// assert_eq!(request.text, "rust storage");
/// ```
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct TextSearchRequest {
    /// Shared query scope and text options.
    pub query: ScopedQuery<TextQueryOptions>,
    /// Full-text query string sent to the backend.
    pub text: String,
}

impl ApplyDefaultLocator for TextSearchRequest {
    fn apply_default_locator(mut self, default: &StorageLocator) -> Self {
        self.query = self.query.apply_default_locator(default);
        self
    }
}

impl TextSearchRequest {
    /// Creates a text search request with all fields projected.
    ///
    /// # Examples
    ///
    /// ```
    /// let request = storage_kit::database::query::TextSearchRequest::new(
    ///     storage_kit::database::StorageLocator::new("documents"),
    ///     "rust storage",
    /// );
    /// assert_eq!(request.text, "rust storage");
    /// ```
    #[must_use]
    pub fn new(locator: StorageLocator, query: impl Into<String>) -> Self {
        Self {
            query: ScopedQuery::text(locator),
            text: query.into(),
        }
    }
}