Struct Db 

pub struct Db {
    pub path: PathBuf,
    pub db_info: Persist<DbInfo>,
    pub seq: Arc<SeqGen>,
    /* private fields */
}

Manager for multiple named trees with persistent metadata and sequence generation.

Fields

path: PathBuf

db_info: Persist<DbInfo>

seq: Arc<SeqGen>

Implementations

impl Db

pub fn listen_tcp(&self, addr: impl ToSocketAddrsAsync + Send + 'static)

pub fn listen_uds(&self, path: impl AsRef<Path> + Send + 'static)

impl Db

pub fn open(path: impl AsRef<Path>) -> DbResult<Self>

pub fn open_with_compaction( path: impl AsRef<Path>, compaction_interval: Option<Duration>, ) -> DbResult<Self>

pub fn tree_path(&self, name: &str, version: u16) -> PathBuf

pub fn next_id(&self, name: &str) -> DbResult<u64>

Generate the next sequential ID for a named collection.

pub fn collection_len<T: CollectionMeta>(&self) -> u64

Get the last saved collection length from db.info.

pub fn close(&self) -> DbResult<()>

Flush all collection lengths to db.info and flush the sequence generator.

pub fn compact(&self) -> DbResult<usize>

Trigger a compaction pass for all collections.

pub fn open_typed_tree<T, C>( &self, config: Config, migrations: &[TypedMigration<T::SelfId, T>], ) -> DbResult<Arc<TypedTree<T::SelfId, T, C>>>

where T: CollectionMeta + Clone + Send + Sync + 'static, T::SelfId: Key + Ord + Send + Sync, C: Codec<T> + Default + 'static,

Open a TypedTree with auto-migration.

pub fn open_typed_tree_hooked<T, C, H>( &self, config: Config, hook: H, migrations: &[TypedMigration<T::SelfId, T>], ) -> DbResult<Arc<TypedTree<T::SelfId, T, C, H>>>

where T: CollectionMeta + Clone + Send + Sync + 'static, T::SelfId: Key + Ord + Send + Sync, C: Codec<T> + Default + 'static, H: TypedWriteHook<T::SelfId, T> + 'static,

Open a TypedTree with a write hook.

pub fn open_typed_map<T, C>( &self, config: Config, migrations: &[TypedMigration<T::SelfId, T>], ) -> DbResult<Arc<TypedMap<T::SelfId, T, C>>>

where T: CollectionMeta + Clone + Send + Sync + 'static, T::SelfId: Key + Send + Sync + Hash + Eq, C: Codec<T> + Default + 'static,

Open a TypedMap with auto-migration.

pub fn open_typed_map_hooked<T, C, H>( &self, config: Config, hook: H, migrations: &[TypedMigration<T::SelfId, T>], ) -> DbResult<Arc<TypedMap<T::SelfId, T, C, H>>>

where T: CollectionMeta + Clone + Send + Sync + 'static, T::SelfId: Key + Send + Sync + Hash + Eq, C: Codec<T> + Default + 'static, H: TypedWriteHook<T::SelfId, T> + 'static,

Open a TypedMap with a write hook.

pub fn open_zero_tree<T, const V: usize>( &self, config: Config, migrations: &[ZeroMigration<T::SelfId, T>], ) -> DbResult<Arc<ZeroTree<T::SelfId, V, Bitcask, T>>>

where T: CollectionMeta + Copy + Send + Sync + 'static, T::SelfId: Key + Ord + Send + Sync,

Open a ZeroTree with auto-migration.

pub fn open_zero_tree_hooked<T, const V: usize, H>( &self, config: Config, hook: H, migrations: &[ZeroMigration<T::SelfId, T>], ) -> DbResult<Arc<ZeroTree<T::SelfId, V, Bitcask, T, H>>>

where T: CollectionMeta + Copy + Send + Sync + 'static, T::SelfId: Key + Ord + Send + Sync, H: TypedWriteHook<T::SelfId, T> + 'static,

Open a ZeroTree with a write hook.

pub fn open_zero_map<T, const V: usize>( &self, config: Config, migrations: &[ZeroMigration<T::SelfId, T>], ) -> DbResult<Arc<ZeroMap<T::SelfId, V, Bitcask, T>>>

where T: CollectionMeta + Copy + Send + Sync + 'static, T::SelfId: Key + Send + Sync + Hash + Eq,

Open a ZeroMap with auto-migration.

pub fn open_zero_map_hooked<T, const V: usize, H>( &self, config: Config, hook: H, migrations: &[ZeroMigration<T::SelfId, T>], ) -> DbResult<Arc<ZeroMap<T::SelfId, V, Bitcask, T, H>>>

where T: CollectionMeta + Copy + Send + Sync + 'static, T::SelfId: Key + Send + Sync + Hash + Eq, H: TypedWriteHook<T::SelfId, T> + 'static,

Open a ZeroMap with a write hook.

impl Db

pub fn build_tree_map(&self) -> TreeMap

Build the RPC routing table from all registered handlers.

Trait Implementations

impl Drop for Db

fn drop(&mut self)

Executes the destructor for this type.