Struct Snapshot

pub struct Snapshot { /* private fields */ }

Implementations

impl Snapshot

pub fn database(&self) -> Database

Get the owning database

pub fn id(&self) -> SnapshotId

Get the numerical id

pub fn name(&self) -> BnString

Get the displayed snapshot name

pub fn set_name<S: BnStrCompatible>(&self, value: S)

Set the displayed snapshot name

pub fn is_auto_save(&self) -> bool

If the snapshot was the result of an auto-save

pub fn has_contents(&self) -> bool

If the snapshot has contents, and has not been trimmed

pub fn has_undo(&self) -> bool

If the snapshot has undo data

pub fn first_parent(&self) -> Option<Snapshot>

Get the first parent of the snapshot, or None if it has no parents

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

Get a list of all parent snapshots of the snapshot

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

Get a list of all child snapshots of the snapshot

pub fn file_contents(&self) -> Option<DataBuffer>

Get a buffer of the raw data at the time of the snapshot

pub fn file_contents_hash(&self) -> Option<DataBuffer>

Get a hash of the data at the time of the snapshot

pub fn undo_entries(&self) -> Array<UndoEntry>

Get a list of undo entries at the time of the snapshot

pub fn undo_entries_with_progress<P: ProgressCallback>( &self, progress: P, ) -> Array<UndoEntry>

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

Get the backing kvs data with snapshot fields

pub fn read_data_with_progress<P: ProgressCallback>( &self, progress: P, ) -> Ref<KeyValueStore>

pub fn undo_data(&self) -> DataBuffer

pub fn store_data(&self, data: &KeyValueStore) -> bool

pub fn store_data_with_progress<P: ProgressCallback>( &self, data: &KeyValueStore, progress: P, ) -> bool

pub fn has_ancestor(self, other: &Snapshot) -> bool

Determine if this snapshot has another as an ancestor

Trait Implementations

impl CoreArrayProvider for Snapshot

type Raw = *mut BNSnapshot

type Context = ()

type Wrapped<'a> = Guard<'a, Snapshot>

impl Debug for Snapshot

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

Formats the value using the given formatter.

impl ToOwned for Snapshot

type Owned = Ref<Snapshot>

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.