Struct sonic_channel::SearchChannel

source · [−]

pub struct SearchChannel(_);

Expand description

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.

Implementations

source

impl SearchChannel

source

pub fn quit(&self) -> Result<<QuitCommand as StreamCommand>::Response>

Stop connection.

let channel = SearchChannel::start(
    "localhost:1491",
    "SecretPassword",
)?;

channel.quit()?;

source

pub fn ping(&self) -> Result<<PingCommand as StreamCommand>::Response>

Ping server.

let channel = SearchChannel::start(
    "localhost:1491",
    "SecretPassword",
)?;

channel.ping()?;

source

impl SearchChannel

source

pub fn query(
&self,
req: QueryRequest
) -> Result<<QueryCommand as StreamCommand>::Response>

Query objects in database.

Note: This method requires enabling the search feature and start connection in Search mode.

let search_channel = SearchChannel::start(
    "localhost:1491",
    "SecretPassword",
)?;

let result = search_channel.query(QueryRequest::new(
    Dest::col("search"),
    "Beef",
))?;
dbg!(result);

let result = search_channel.query(
    QueryRequest::new(Dest::col("search"), "Beef").limit(10)
)?;
dbg!(result);

source

pub fn suggest(
&self,
req: SuggestRequest
) -> Result<<SuggestCommand as StreamCommand>::Response>

Suggest auto-completes words.

Note: This method requires enabling the search feature and start connection in Search mode.

let search_channel = SearchChannel::start(
    "localhost:1491",
    "SecretPassword",
)?;

let result = search_channel.suggest(
    SuggestRequest::new(Dest::col("search"), "Beef")
)?;
dbg!(result);

let result = search_channel.suggest(
    SuggestRequest::new(Dest::col("search"), "Beef").limit(2)
)?;
dbg!(result);

source

pub fn list(
&self,
req: ListRequest
) -> Result<<ListCommand as StreamCommand>::Response>

Enumerates all words in an index.

Note: This method requires enabling the search feature and start connection in Search mode.

let search_channel = SearchChannel::start(
    "localhost:1491",
    "SecretPassword",
)?;

let result = search_channel.list(
    ListRequest::new(Dest::col("search"))
)?;
dbg!(result);

let result = search_channel.list(
    ListRequest::new(Dest::col("search")).limit(2)
)?;
dbg!(result);