Struct Database 

pub struct Database(/* private fields */);

Memory-mapped database with dynamic space allocation and hole punching.

Provides efficient storage through memory mapping with automatic region management, space reclamation via hole punching, and dynamic file growth as needed.

Implementations

impl Database

pub fn open(path: &Path) -> Result<Self>

Opens or creates a database at the specified path.

pub fn open_with_min_len(path: &Path, min_len: u64) -> Result<Self>

Opens or creates a database with a minimum initial file size.

pub fn file_len(&self) -> Result<u64>

pub fn set_min_len(&self, len: u64) -> Result<()>

pub fn set_min_regions(&self, regions: usize) -> Result<()>

pub fn get_region(&self, id: &str) -> Option<Region>

Gets an existing region by ID.

pub fn create_region_if_needed(&self, id: &str) -> Result<Region>

Creates a region with the given ID, or returns it if it already exists.

pub fn write_all_to_region(&self, region: &Region, data: &[u8]) -> Result<()>

pub fn write_all_to_region_at( &self, region: &Region, data: &[u8], at: u64, ) -> Result<()>

pub fn truncate_write_all_to_region( &self, region: &Region, at: u64, data: &[u8], ) -> Result<()>

pub fn truncate_region(&self, region: &Region, from: u64) -> Result<()>

From relative to start

Non destructive

pub fn remove_region_with_id(&self, id: &str) -> Result<Option<Region>>

pub fn rename_region(&self, old_id: &str, new_id: &str) -> Result<()>

pub fn remove_region(&self, region: Region) -> Result<Option<Region>>

pub fn retain_regions(&self, ids: HashSet<String>) -> Result<()>

pub fn mmap(&self) -> RwLockReadGuard<'_, MmapMut>

pub fn regions(&self) -> RwLockReadGuard<'_, Regions>

pub fn layout(&self) -> RwLockReadGuard<'_, Layout>

pub fn open_read_only_file(&self) -> Result<File>

Open a dedicated file handle for sequential reading This enables optimal kernel readahead for iteration

pub fn disk_usage(&self) -> String

pub fn flush(&self) -> Result<()>

pub fn compact(&self) -> Result<()>

pub fn path(&self) -> &Path

pub fn weak_clone(&self) -> WeakDatabase

Trait Implementations

impl Clone for Database

fn clone(&self) -> Database

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Database

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

Formats the value using the given formatter.

impl Deref for Database

type Target = Arc<DatabaseInner>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.