Struct sonic_channel::ControlChannel

pub struct ControlChannel(_);

The Sonic Channel Control mode is used for administration purposes. 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 consolidate, backup, restore, ping and quit commands.

Note: This mode requires enabling the control feature.

Implementations

impl ControlChannel

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

Stop connection.

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

channel.quit()?;

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

Ping server.

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

channel.ping()?;

impl ControlChannel

pub fn consolidate(
    &self
) -> Result<<TriggerCommand<'_> as StreamCommand>::Response>

Consolidate indexed search data instead of waiting for the next automated consolidation tick.

Note: This method requires enabling the control feature and start connection in Control mode.

let control_channel = ControlChannel::start(
    "localhost:1491",
    "SecretPassword",
)?;

let result = control_channel.consolidate()?;
assert_eq!(result, true);

pub fn backup<'a>(
    &self,
    action: &'a str
) -> Result<<TriggerCommand<'_> as StreamCommand>::Response>

Backup KV + FST to /<BACKUP_{KV/FST}_PATH> See sonic backend source code for more information.

Note: This method requires enabling the control feature and start connection in Control mode.

let control_channel = ControlChannel::start(
    "localhost:1491",
    "SecretPassword",
)?;

let result = control_channel.backup("2020-08-07T23-48")?;
assert_eq!(result, true);

pub fn restore<'a>(
    &self,
    action: &'a str
) -> Result<<TriggerCommand<'_> as StreamCommand>::Response>

Restore KV + FST from if you already have backup with the same name.

Note: This method requires enabling the control feature and start connection in Control mode.

let control_channel = ControlChannel::start(
    "localhost:1491",
    "SecretPassword",
)?;

let result = control_channel.restore("2020-08-07T23-48")?;
assert_eq!(result, true);

Trait Implementations

impl Debug for ControlChannel

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl SonicChannel for ControlChannel

type Channel = ControlChannel

Sonic channel struct

pub fn stream(&self) -> &SonicStream

Returns reference for sonic stream of connection

pub fn start<A, S>(addr: A, password: S) -> Result<Self::Channel> where
    A: ToSocketAddrs,
    S: ToString, 

Connects to sonic backend and run start command.