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 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217
use super::{ChannelMode, SonicChannel, SonicStream}; use crate::commands::*; use crate::result::Result; use std::net::ToSocketAddrs; /// The Sonic Channel Search mode is used for querying the search index. /// Once in this mode, you cannot switch to other modes or gain access /// to commands from other modes. /// /// ### Available commands /// /// In this mode you can use `query`, `suggest`, `ping` and `quit` commands. /// /// **Note:** This mode requires enabling the `search` feature. #[derive(Debug)] pub struct SearchChannel(SonicStream); impl SonicChannel for SearchChannel { type Channel = SearchChannel; fn stream(&self) -> &SonicStream { &self.0 } fn start<A, S>(addr: A, password: S) -> Result<Self::Channel> where A: ToSocketAddrs, S: ToString, { SonicStream::connect_with_start(ChannelMode::Search, addr, password).map(Self) } } impl SearchChannel { init_command!( /// Stop connection. /// /// ```rust,no_run /// # use sonic_channel::*; /// # fn main() -> result::Result<()> { /// let channel = SearchChannel::start( /// "localhost:1491", /// "SecretPassword", /// )?; /// /// channel.quit()?; /// # Ok(()) /// # } use QuitCommand for fn quit(); ); init_command!( /// Ping server. /// /// ```rust,no_run /// # use sonic_channel::*; /// # fn main() -> result::Result<()> { /// let channel = SearchChannel::start( /// "localhost:1491", /// "SecretPassword", /// )?; /// /// channel.ping()?; /// # Ok(()) /// # } use PingCommand for fn ping(); ); } impl SearchChannel { init_command!( /// Query objects in database. /// /// Note: This method requires enabling the `search` feature and start /// connection in Search mode. /// /// ```rust,no_run /// # use sonic_channel::*; /// # fn main() -> result::Result<()> { /// let search_channel = SearchChannel::start( /// "localhost:1491", /// "SecretPassword", /// )?; /// /// let result = search_channel.query("search", "default", "Beef")?; /// dbg!(result); /// # Ok(()) /// # } /// ``` use QueryCommand for fn query<'a>( collection: &'a str, bucket: &'a str, terms: &'a str, ); ); init_command!( /// Query limited objects in database. This method similar query but /// you can configure limit of result. /// /// Note: This method requires enabling the `search` feature and start /// connection in Search mode. /// /// ```rust,no_run /// # use sonic_channel::*; /// # fn main() -> result::Result<()> { /// let search_channel = SearchChannel::start( /// "localhost:1491", /// "SecretPassword", /// )?; /// /// let result = search_channel.query_with_limit( /// "search", /// "default", /// "Beef", /// 10, /// )?; /// dbg!(result); /// # Ok(()) /// # } /// ``` use QueryCommand for fn query_with_limit<'a>( collection: &'a str, bucket: &'a str, terms: &'a str, limit: usize => Some(limit), ); ); init_command!( /// Query limited objects in database. This method similar /// query_with_limit but you can put offset in your query. /// /// Note: This method requires enabling the `search` feature and start /// connection in Search mode. /// /// ```rust,no_run /// # use sonic_channel::*; /// # fn main() -> result::Result<()> { /// let search_channel = SearchChannel::start( /// "localhost:1491", /// "SecretPassword", /// )?; /// /// let result = search_channel.query_with_limit_and_offset( /// "search", /// "default", /// "Beef", /// 10, /// 10, /// )?; /// dbg!(result); /// # Ok(()) /// # } /// ``` use QueryCommand for fn query_with_limit_and_offset<'a>( collection: &'a str, bucket: &'a str, terms: &'a str, limit: usize => Some(limit), offset: usize => Some(offset), ) ); init_command!( /// Suggest auto-completes words. /// /// Note: This method requires enabling the `search` feature and start /// connection in Search mode. /// /// ```rust,no_run /// # use sonic_channel::*; /// # fn main() -> result::Result<()> { /// let search_channel = SearchChannel::start( /// "localhost:1491", /// "SecretPassword", /// )?; /// /// let result = search_channel.suggest("search", "default", "Beef")?; /// dbg!(result); /// # Ok(()) /// # } /// ``` use SuggestCommand for fn suggest<'a>( collection: &'a str, bucket: &'a str, word: &'a str, ); ); init_command!( /// Suggest auto-completes words with limit. /// /// Note: This method requires enabling the `search` feature and start /// connection in Search mode. /// /// ```rust,no_run /// # use sonic_channel::*; /// # fn main() -> result::Result<()> { /// let search_channel = SearchChannel::start( /// "localhost:1491", /// "SecretPassword", /// )?; /// /// let result = search_channel.suggest_with_limit("search", "default", "Beef", 5)?; /// dbg!(result); /// # Ok(()) /// # } /// ``` use SuggestCommand for fn suggest_with_limit<'a>( collection: &'a str, bucket: &'a str, word: &'a str, limit: usize => Some(limit), ); ); }