Struct Handle

pub struct Handle { /* private fields */ }

Provides access to a storage directory. Manages manifest access, file cloning, file writers, configuration, value eviction etc.

Implementations

impl Handle

pub fn dir_supports_file_cloning(&self) -> bool

Whether file cloning should be attempted.

pub fn set_instance_limits(&mut self, limits: Limits) -> Result<()>

pub fn dir(&self) -> &Path

pub fn new(dir: PathBuf) -> Result<Self>

pub fn cleanup_snapshots(&self) -> PubResult<()>

pub fn block_size(&self) -> u64

pub fn new_writer(&self) -> Result<BatchWriter<&Handle>>

pub fn start_deferred_transaction_for_read(&self) -> Result<OwnedReadTx<'_>>

Starts a deferred transaction (the default). There is no guaranteed read-only transaction mode. There might be pragmas that can limit to read only statements.

pub fn read(&self) -> Result<Reader<OwnedTx<'_>>>

Begins a read transaction.

pub fn read_single(&self, key: &[u8]) -> Result<Option<SnapshotValue<Value>>>

pub fn single_write_from( &self, key: Vec<u8>, r: impl Read, ) -> Result<(u64, WriteCommitResult)>

pub fn single_delete(&self, key: &[u8]) -> PubResult<Option<PossumStat>>

pub fn clone_from_file(&mut self, key: Vec<u8>, file: &mut File) -> Result<u64>

pub fn rename_item(&mut self, from: &[u8], to: &[u8]) -> PubResult<Timestamp>

pub fn walk_dir(&self) -> Result<Vec<Entry>>

Walks the underlying files in the possum directory.

pub fn list_items(&self, prefix: &[u8]) -> PubResult<Vec<Item>>

pub fn get_value_puncher_done(&self) -> ValuePuncherDone

Returns something that can be used to test if the value puncher routine for this Handle has returned.

pub fn move_prefix(&self, from: &[u8], to: &[u8]) -> Result<()>

pub fn delete_prefix(&self, prefix: impl AsRef<[u8]>) -> PubResult<()>

Trait Implementations

impl AsRef<Handle> for Handle

fn as_ref(&self) -> &Handle

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Handle> for Rc<RwLockReadGuard<'_, Handle>>

fn as_ref(&self) -> &Handle

Converts this type into a shared reference of the (usually inferred) input type.

impl Debug for Handle

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

Formats the value using the given formatter.

impl Drop for Handle

fn drop(&mut self)

Executes the destructor for this type.