Struct TableBuilder

pub struct TableBuilder { /* private fields */ }

Builder Pattern for creating a new Table

Implementations

impl TableBuilder

pub fn name(self, name: String) -> Self

Sets the Name of the Table

use persistent_keystore_rs::Table;
let table = Table::new()
    .name("MyTable".to_string());

pub fn primary_field(self, priary_key: FieldType) -> Result<Self, DatabaseError>

Sets the FieldType of the primary_field

use persistent_keystore_rs::{Table, FieldType};
let table = Table::new()
    .primary_field(FieldType::String).unwrap();

pub fn add_field( self, key: String, field_type: FieldType, ) -> Result<Self, DatabaseError>

Add a required field of FieldType and name to the Table

use persistent_keystore_rs::{Table, FieldType};
let table = Table::new()
    .add_field("Count".to_string(), FieldType::I64).unwrap();

pub fn add_optional_field( self, key: String, field_type: FieldType, ) -> Result<Self, DatabaseError>

Add an optional field of FieldType and name to the Table

use persistent_keystore_rs::{Table, FieldType};
let table = Table::new()
    .add_optional_field("Notes".to_string(), FieldType::String).unwrap();

pub fn add_expiration(self, expire_after: Duration) -> Self

Add an expiration Duration to the Table. The timer for the expiration is set to the last time an Entry was updated.

Note that this does not happen automatically within this struct; but is utilized within Client

use persistent_keystore_rs::{Table, FieldType};
use std::time::Duration;
 
let table = Table::new()
    .add_expiration(Duration::from_secs(60));

pub fn build(self) -> Result<Table, DatabaseError>

Validates the Table is properly configured and returns the Table object.

use persistent_keystore_rs::{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();