Struct sherwood::FileHandle [-] [+] [src]

pub struct FileHandle {
    // some fields omitted
}

ForestDB file handle

Methods

impl FileHandle

fn open(path: &Path, config: Config) -> FdbResult<FileHandle>

Opens database with specified config

fn get_default_store(&self, config: StoreConfig) -> FdbResult<KvHandle<ReadWrite>>

Retrieves default store

fn get_store(&self, name: &str, config: StoreConfig) -> FdbResult<KvHandle<ReadWrite>>

Retrieves store by name

fn commit(&self, options: CommitOptions) -> FdbResult<()>

Commit all pending doc changes

fn compact(&self, new_path: Option<PathBuf>) -> FdbResult<()>

Writes compacted database to new_path. If it is set to None - it'll be in-place compaction

fn estimate_size(&self) -> u64

Estimates space used by file

fn begin_transaction(&self, isolation: IsolationLevel) -> FdbResult<()>

Starts a transaction with specified isolation level

fn end_transaction(&self, options: CommitOptions) -> FdbResult<()>

Ends current transaction with specified commit options

fn abort_transaction(&self) -> FdbResult<()>

Aborts current transaction

fn get_info(&self) -> FdbResult<FileHandleInfo>

Trait Implementations

impl Send for FileHandle

impl Clone for FileHandle

fn clone(&self) -> FileHandle

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

impl Drop for FileHandle

fn drop(&mut self)

impl Display for FileHandle

fn fmt(&self, f: &mut Formatter) -> Result