Struct VibeDbClient 

pub struct VibeDbClient { /* private fields */ }

Database client exposed for advanced integrations. Client used by the SDK to coordinate database worker operations.

Implementations

impl VibeDbClient

pub fn new() -> Self

Creates a database client using the default store backend.

Returns

A VibeDbClient with its worker loop initialized.

pub fn with_backend(backend: VibeStoreBackend) -> Self

Creates a database client using a specific store backend.

Returns

A VibeDbClient with its worker loop initialized for backend.

Examples

use vibe_ready::{VibeDbClient, VibeStoreBackend};

let client = VibeDbClient::with_backend(VibeStoreBackend::Noop);
drop(client);

impl VibeDbClient

pub async fn close(&self) -> Result<(), VibeEngineError>

Closes the worker channel and database backend.

Returns

Ok(()) when closed or already closed, otherwise VibeEngineError.

pub async fn try_open( &self, store_path: PathBuf, user_id: String, is_encrypt: bool, ) -> Result<(), VibeEngineError>

Opens the configured backend at store_path for user_id.

Returns

Ok(()) when the backend is ready, or VibeEngineError on open failure.

impl VibeDbClient

pub async fn set( &self, key: String, value: VibeKvValue, ) -> Result<(), VibeEngineError>

Sets a value in the default bucket.

Returns

Ok(()) when the value is written.

pub async fn set_str( &self, key: String, value: String, ) -> Result<(), VibeEngineError>

Sets a string value in the default bucket.

Returns

Ok(()) when the value is written.

pub async fn set_bool( &self, key: String, value: bool, ) -> Result<(), VibeEngineError>

Sets a boolean value in the default bucket.

Returns

Ok(()) when the value is written.

pub async fn set_i32( &self, key: String, value: i32, ) -> Result<(), VibeEngineError>

Sets an i32 value in the default bucket.

Returns

Ok(()) when the value is written.

pub async fn get( &self, key: String, ) -> Result<Option<VibeKvValue>, VibeEngineError>

Gets a value from the default bucket.

Returns

Ok(Some(value)), Ok(None), or VibeEngineError.

pub async fn get_str( &self, key: String, ) -> Result<Option<String>, VibeEngineError>

Gets a string value from the default bucket.

Returns

Ok(Some(String)) only when the value is a string.

pub async fn get_bool( &self, key: String, ) -> Result<Option<bool>, VibeEngineError>

Gets a boolean value from the default bucket.

Returns

Ok(Some(bool)) only when the value is a boolean.

pub async fn get_i32(&self, key: String) -> Result<Option<i32>, VibeEngineError>

Gets an i32 value from the default bucket.

Returns

Ok(Some(i32)) only when the value is an i32.

pub async fn remove(&self, key: String) -> Result<bool, VibeEngineError>

Removes a key from the default bucket.

Returns

Ok(true) when the key existed and was removed.

pub async fn contains(&self, key: String) -> Result<bool, VibeEngineError>

Checks whether a key exists in the default bucket.

Returns

Ok(true) when the key exists and is not expired.

pub async fn list_keys(&self) -> Result<Vec<String>, VibeEngineError>

Lists keys in the default bucket.

Returns

A vector of key names.

pub async fn current_user_id(&self) -> Result<String, VibeEngineError>

Returns the user id associated with the open backend.

Returns

Ok(String) after VibeDbClient::try_open, otherwise a database-not-open error.

impl VibeDbClient

pub async fn set_in_bucket( &self, bucket: String, key: String, value: VibeKvValue, expires_at_ms: i64, ) -> Result<(), VibeEngineError>

Sets a value in a named bucket.

Returns

Ok(()) when the value is written.

pub async fn get_in_bucket( &self, bucket: String, key: String, ) -> Result<Option<VibeKvValue>, VibeEngineError>

Gets a value from a named bucket.

Returns

Ok(Some(value)), Ok(None) for missing/expired keys, or an error.

pub async fn remove_in_bucket( &self, bucket: String, key: String, ) -> Result<bool, VibeEngineError>

Removes a key from a named bucket.

Returns

Ok(true) when the key existed and was removed.

pub async fn contains_in_bucket( &self, bucket: String, key: String, ) -> Result<bool, VibeEngineError>

Checks whether a key exists in a named bucket.

Returns

Ok(true) when the key exists and is not expired.

pub async fn list_keys_in_bucket( &self, bucket: String, ) -> Result<Vec<String>, VibeEngineError>

Lists keys in a named bucket.

Returns

A vector of key names.

pub async fn get_many_in_bucket( &self, bucket: String, keys: Vec<String>, ) -> Result<Vec<(String, VibeKvValue)>, VibeEngineError>

Reads multiple keys from a named bucket.

Returns

A vector of (key, value) pairs for existing, non-expired keys.

pub async fn set_many_in_bucket( &self, bucket: String, items: Vec<(String, VibeKvValue, i64)>, ) -> Result<(), VibeEngineError>

Writes multiple values to a named bucket in one transaction.

Returns

Ok(()) when the batch commit succeeds.

pub async fn remove_many_in_bucket( &self, bucket: String, keys: Vec<String>, ) -> Result<(), VibeEngineError>

Removes multiple keys from a named bucket in one transaction.

Returns

Ok(()) when the batch commit succeeds.

pub async fn transaction_ops( &self, ops: Vec<DbKvOp>, ) -> Result<(), VibeEngineError>

Apply pre-built ops (already user-scoped) inside one DB transaction.

Returns

Ok(()) when every operation commits atomically.

pub async fn purge_expired(&self) -> Result<usize, VibeEngineError>

Purges expired rows from the backend.

Returns

Number of rows removed by the backend.

impl VibeDbClient

pub async fn insert_or_replace_key_val( &self, table: VibeTableKeyVal, ) -> Result<(), VibeEngineError>

Inserts or replaces a low-level key-value row.

Returns

Ok(()) when the row is written.

pub async fn get_key_val( &self, user_id: String, bucket: String, key: String, ) -> Result<Option<VibeTableKeyVal>, VibeEngineError>

Gets a low-level key-value row.

Returns

Ok(Some(row)), Ok(None), or VibeEngineError.

pub async fn get_key_val_vec( &self, user_id: String, bucket: String, keys: Vec<String>, ) -> Result<Vec<VibeTableKeyVal>, VibeEngineError>

Gets multiple low-level key-value rows.

Returns

A vector of matching rows.

pub async fn remove_key_val( &self, user_id: String, bucket: String, key: String, ) -> Result<bool, VibeEngineError>

Removes a low-level key-value row.

Returns

Ok(true) when a row was removed.

pub async fn contains_key_val( &self, user_id: String, bucket: String, key: String, ) -> Result<bool, VibeEngineError>

Checks whether a low-level key-value row exists.

Returns

Ok(true) when the row exists.

pub async fn list_key_vals( &self, user_id: String, bucket: String, ) -> Result<Vec<String>, VibeEngineError>

Lists low-level key names for a user and bucket.

Returns

A vector of key names.

Trait Implementations

impl Clone for VibeDbClient

fn clone(&self) -> VibeDbClient

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.