Struct Client

Source

pub struct Client { /* private fields */ }

Expand description

The main client struct used to interact with the DiceDB server. Create a new client with Client::new(host: String, port: u16).

Implementations§

Source §

impl Client

Source

pub fn new(host: String, port: u16) -> Result<Self, ClientError>

Create a new client with the given host and port.

§Example

use dicedb_rs::client::Client;
use dicedb_rs::errors::ClientError;
fn main() -> Result<(), ClientError> {
   // Create a new client
   let client = Client::new("localhost".to_string(), 7379)?;
   Ok(())
}

§Errors

Returns a ClientError if the connection to the server fails.

Source §

impl Client

Source

pub fn decr(&mut self, key: &str) -> Result<ScalarValue, StreamError>

Decrements the integer at key by one. Creates key as -1 if absent. Errors on wrong type or non-integer string. Limited to 64-bit signed integers.

§Arguments

key - The key to decrement.

§Returns

[Value] - The new value of key.

§Errors

StreamError - If an error occured in the communication stream.

Source

pub fn decrby( &mut self, key: &str, delta: i64, ) -> Result<ScalarValue, StreamError>

Decrements the integer at key by delta. Creates key as -delta if absent. Errors on wrong type or non-integer string. Limited to 64-bit signed integers.

§Arguments

key - The key to decrement.
delta - The amount to decrement by.

§Returns

[Value] - The new value of key.

§Errors

StreamError - If an error occured in the communication stream.

Source

pub fn del<'a, T: Into<DelInput<'a>>>( &mut self, keys: T, ) -> Result<ScalarValue, StreamError>

Deletes all the specified keys and returns the number of keys deleted on success.

§Arguments

keys - The keys to delete, either a single key or multiple keys.

§Returns

[Value] - The number of keys deleted.

§Errors

StreamError - If an error occured in the communication stream.

Source

pub fn echo(&mut self, message: &str) -> Result<ScalarValue, StreamError>

Echos a message with the server, ie. returns the message passed to it.

§Arguments

message - The message to return.

§Returns

[Value] - The message.

§Errors

StreamError - If an error occured in the communication stream.

Source

pub fn exists( &mut self, key: &str, additional_keys: Vec<&str>, ) -> Result<ScalarValue, StreamError>

Checks if the specified keys exist.

§Arguments

key - The key to check.
additional_keys - Additional keys to check. If empty, only key is checked.

§Returns

[Value] - The number of keys that exist.

§Errors

StreamError - If an error occured in the communication stream.

Source

pub fn expire( &mut self, key: &str, seconds: i64, option: ExpireOption, ) -> Result<ScalarValue, StreamError>

Sets an expiry (in seconds) on a specified key. After the expiry time has elapsed, the key will be automatically deleted.

§Arguments

key - The key to set the expiry on.
seconds - The number of seconds until the key expires.
option: ExpireOption - The option to specify conditions for setting the expiry.

§Returns

[Value] - 1 if the expiry was set, 0 if expire was not set.

§Errors

StreamError - If an error occured in the communication stream.

Source

pub fn expireat( &mut self, key: &str, timestamp: i64, option: ExpireAtOption, ) -> Result<ScalarValue, StreamError>

Sets the expiration time of a key as an absolute Unix timestamp (in seconds). After the expiry time has elapsed, the key will be automatically deleted.

§Arguments

key - The key to set the expiry on.
timestamp - The Unix timestamp in seconds.
option: ExpireAtOption - The option to specify conditions for setting the expiry.