Struct persy::OpenOptions

pub struct OpenOptions { /* private fields */ }

Options, flags, configs which can be used to configure how a persy database is opened.

use persy::{OpenOptions, Persy, PersyId, ValueMode};

// This function will only be called on database creation
fn init(persy: &Persy) -> Result<(), Box<dyn std::error::Error>> {
    let mut tx = persy.begin()?;

    tx.create_segment("data")?;
    tx.create_index::<u64, PersyId>("index", ValueMode::Replace)?;

    let prepared = tx.prepare()?;
    prepared.commit()?;

    println!("Segment and Index successfully created");
    Ok(())
}

let persy = OpenOptions::new().create(true).prepare_with(init).open("target/persy.db")?;

Implementations

impl OpenOptions

pub fn new() -> OpenOptions

pub fn truncate(&mut self, truncate: bool) -> &mut OpenOptions

Truncate the file on open removing all the persistent data

pub fn create(&mut self, create: bool) -> &mut OpenOptions

Create a new file if not exists

pub fn create_new(&mut self, create_new: bool) -> &mut OpenOptions

Create a new file if exists fail

pub fn prepare_with<F>(&mut self, prepare: F) -> &mut OpenOptions

where F: Fn(&Persy) -> Result<(), Box<dyn Error>> + 'static,

Provide a function for initialize the storage in case did not existed

pub fn recover_with<F>(&mut self, recover: F) -> &mut OpenOptions

where F: Fn(&Vec<u8>) -> bool + 'static,

Provide a function for check if a transaction must be committed or rollback in case of recover from crash

pub fn config(&mut self, config: Config) -> &mut OpenOptions

Provide general storage configurations

pub fn recover<P>(&mut self, path: P) -> Result<Recover, PE<OpenError>>

where P: AsRef<Path>,

Open a file to a recover structure to list pending transactions and select witch commit and rollback

pub fn recover_file(&mut self, file: File) -> Result<Recover, PE<OpenError>>

Open a file to a recover structure to list pending transactions and select witch commit and rollback

pub fn open<P>(&mut self, path: P) -> Result<Persy, PE<OpenError>>

where P: AsRef<Path>,

Open a file from the given path with the current options

pub fn memory(&mut self) -> Result<Persy, PE<OpenMemoryError>>

Create a persy instance backed by a Vec<u8> with no persistence

Example

use persy::{OpenOptions, Persy, PersyId, ValueMode};


let persy = OpenOptions::new().memory()?;

Trait Implementations

impl Default for OpenOptions

fn default() -> OpenOptions

Returns the “default value” for a type.