couchbase 1.0.1

The official Couchbase Rust SDK
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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

/*
 *
 *  * Copyright (c) 2025 Couchbase, Inc.
 *  *
 *  * Licensed under the Apache License, Version 2.0 (the "License");
 *  * you may not use this file except in compliance with the License.
 *  * You may obtain a copy of the License at
 *  *
 *  *    http://www.apache.org/licenses/LICENSE-2.0
 *  *
 *  * Unless required by applicable law or agreed to in writing, software
 *  * distributed under the License is distributed on an "AS IS" BASIS,
 *  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  * See the License for the specific language governing permissions and
 *  * limitations under the License.
 *
 */

use crate::error;
use crate::search::queries::Query;
use crate::search::vector::VectorSearch;

/// A Full-Text Search request that may contain a search query, a vector search, or both.
///
/// Create a request using [`with_search_query`](SearchRequest::with_search_query)
/// or [`with_vector_search`](SearchRequest::with_vector_search), then optionally
/// combine them using the builder methods.
///
/// # Example
///
/// ```rust
/// use couchbase::search::request::SearchRequest;
/// use couchbase::search::queries::{Query, MatchQuery};
///
/// let request = SearchRequest::with_search_query(
///     Query::Match(MatchQuery::new("airport"))
/// );
/// ```
#[derive(Debug, Clone)]
pub struct SearchRequest {
    pub(crate) search_query: Option<Query>,
    pub(crate) vector_search: Option<VectorSearch>,
}

impl SearchRequest {
    /// Creates a `SearchRequest` containing only a text search query.
    pub fn with_search_query(search_query: Query) -> Self {
        Self {
            search_query: Some(search_query),
            vector_search: None,
        }
    }

    /// Creates a `SearchRequest` containing only a vector search.
    pub fn with_vector_search(vector_search: VectorSearch) -> Self {
        Self {
            search_query: None,
            vector_search: Some(vector_search),
        }
    }

    /// Adds a vector search to this request.
    ///
    /// Returns an error if a vector search has already been set.
    pub fn vector_search(mut self, vector_search: VectorSearch) -> error::Result<Self> {
        if self.vector_search.is_some() {
            return Err(error::Error::invalid_argument(
                "vector_search",
                "vector search already set",
            ));
        }
        self.vector_search = Some(vector_search);
        Ok(self)
    }

    /// Adds a text search query to this request.
    ///
    /// Returns an error if a search query has already been set.
    pub fn search_query(mut self, search_query: Query) -> error::Result<Self> {
        if self.search_query.is_some() {
            return Err(error::Error::invalid_argument(
                "search_query",
                "search query already set",
            ));
        }
        self.search_query = Some(search_query);
        Ok(self)
    }
}