Struct Database

pub struct Database {
    pub sync_interval: Option<Duration>,
    /* private fields */
}

Database; a collection of Tables

Fields

sync_interval: Option<Duration>

Implementations

impl Database

pub fn set_sync_duration(&mut self, duration: Duration)

Sets the Sync Duration of the Database.

Note this is currently only utilized by the Client

use persistent_keystore_rs::Database;
use std::time::Duration;
 
let mut database = Database::default();
database.set_sync_duration(Duration::from_secs(60));

pub fn remove_sync_duration(&mut self)

Removes the Sync Duration of the Database.

Note this is currently only utilized by the Client

use persistent_keystore_rs::Database;
 
let mut database = Database::default();
database.remove_sync_duration();

pub fn get_table(&mut self, table: &String) -> Result<&mut Table, DatabaseError>

Returns a mutable reference to a Table within the Database

use persistent_keystore_rs::Database;
 
let mut database = Database::default();
let table = database.get_table(&"MyTable".to_string()).unwrap();

pub fn create_table(&mut self, table: Table) -> Result<(), DatabaseError>

Creates a Table within the Database

use persistent_keystore_rs::{Database, Table, FieldType};
use std::time::Duration;
 
let table = Table::new()
    .name("MyTable".to_string())
    .primary_field(FieldType::String).unwrap()
    .add_field("Count".to_string(), FieldType::I64).unwrap()
    .add_optional_field("Notes".to_string(), FieldType::String).unwrap()
    .add_expiration(Duration::from_secs(60))
    .build().unwrap();
 
let mut database = Database::default();
database.create_table(table).unwrap();

pub fn drop_table(&mut self, table: &String) -> Result<(), DatabaseError>

Deletes the specified Table within the Database

use persistent_keystore_rs::Database;
 
let mut database = Database::default();
database.drop_table(&"MyTable".to_string()).unwrap();

pub fn list_tables(&mut self) -> Vec<String>

Returns a Vec of Table names that are stored within the Database

use persistent_keystore_rs::Database;
 
let mut database = Database::default();
let tables = database.list_tables();

Trait Implementations

impl Clone for Database

fn clone(&self) -> Database

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for Database

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Database

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Database

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.