Struct Database

pub struct Database { /* private fields */ }

Implementations

impl Database

pub fn snapshot_by_id(&self, id: SnapshotId) -> Option<Ref<Snapshot>>

Get a snapshot by its id, or None if no snapshot with that id exists

pub fn snapshots(&self) -> Array<Snapshot>

Get a list of all snapshots in the database

pub fn current_snapshot(&self) -> Option<Ref<Snapshot>>

Get the current snapshot

pub fn set_current_snapshot(&self, value: &Snapshot)

Equivalent to Self::set_current_snapshot_id.

pub fn set_current_snapshot_id(&self, id: SnapshotId)

Sets the current snapshot to the SnapshotId.

No validation is done to ensure that the id is valid.

pub fn write_snapshot_data<N: BnStrCompatible>( &self, parents: &[SnapshotId], file: &BinaryView, name: N, data: &KeyValueStore, auto_save: bool, ) -> SnapshotId

pub fn write_snapshot_data_with_progress<N, P>( &self, parents: &[SnapshotId], file: &BinaryView, name: N, data: &KeyValueStore, auto_save: bool, progress: P, ) -> SnapshotId

where N: BnStrCompatible, P: ProgressCallback,

pub fn trim_snapshot(&self, id: SnapshotId) -> Result<(), ()>

Trim a snapshot’s contents in the database by id, but leave the parent/child hierarchy intact. Future references to this snapshot will return False for has_contents

pub fn remove_snapshot(&self, id: SnapshotId) -> Result<(), ()>

Remove a snapshot in the database by id, deleting its contents and references. Attempting to remove a snapshot with children will raise an exception.

pub fn has_global<S: BnStrCompatible>(&self, key: S) -> bool

pub fn global_keys(&self) -> Array<BnString>

Get a list of keys for all globals in the database

pub fn globals(&self) -> HashMap<String, String>

Get a dictionary of all globals

pub fn read_global<S: BnStrCompatible>(&self, key: S) -> Option<BnString>

Get a specific global by key

pub fn write_global<K: BnStrCompatible, V: BnStrCompatible>( &self, key: K, value: V, ) -> bool

Write a global into the database

pub fn read_global_data<S: BnStrCompatible>(&self, key: S) -> Option<DataBuffer>

Get a specific global by key, as a binary buffer

pub fn write_global_data<K: BnStrCompatible>( &self, key: K, value: &DataBuffer, ) -> bool

Write a binary buffer into a global in the database

pub fn file(&self) -> Ref<FileMetadata>

Get the owning FileMetadata

pub fn analysis_cache(&self) -> Ref<KeyValueStore>

Get the backing analysis cache kvs

pub fn reload_connection(&self)

pub fn write_analysis_cache(&self, val: &KeyValueStore) -> Result<(), ()>

pub fn snapshot_has_data(&self, id: SnapshotId) -> bool

Trait Implementations

impl Debug for Database

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

Formats the value using the given formatter.

impl ToOwned for Database

type Owned = Ref<Database>

The resulting type after obtaining ownership.

fn to_owned(&self) -> Self::Owned

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

Uses borrowed data to replace owned data, usually by cloning.