Struct RemoteSnapshot

pub struct RemoteSnapshot { /* private fields */ }

Implementations

impl RemoteSnapshot

pub fn get_for_local_snapshot( snapshot: &Snapshot, ) -> Result<Option<Ref<RemoteSnapshot>>, ()>

Get the remote snapshot associated with a local snapshot (if it exists)

pub fn file(&self) -> Result<Ref<RemoteFile>, ()>

Owning File

pub fn project(&self) -> Result<Ref<RemoteProject>, ()>

Owning Project

pub fn remote(&self) -> Result<Ref<Remote>, ()>

Owning Remote

pub fn url(&self) -> BnString

Web api endpoint url

pub fn id(&self) -> BnString

Unique id

pub fn name(&self) -> BnString

Name of snapshot

pub fn title(&self) -> BnString

Get the title of a snapshot: the first line of its name

pub fn description(&self) -> BnString

Get the description of a snapshot: the lines of its name after the first line

pub fn author(&self) -> BnString

Get the user id of the author of a snapshot

pub fn author_username(&self) -> BnString

Get the username of the author of a snapshot, if possible (vs author which is user id)

pub fn created(&self) -> SystemTime

Created date of Snapshot

pub fn last_modified(&self) -> SystemTime

Date of last modification to the snapshot

pub fn hash(&self) -> BnString

Hash of snapshot data (analysis and markup, etc) No specific hash algorithm is guaranteed

pub fn snapshot_file_hash(&self) -> BnString

Hash of file contents in snapshot No specific hash algorithm is guaranteed

pub fn has_pulled_undo_entries(&self) -> bool

If the snapshot has pulled undo entries yet

pub fn is_finalized(&self) -> bool

If the snapshot has been finalized on the server and is no longer editable

pub fn parent_ids(&self) -> Result<Array<BnString>, ()>

List of ids of all remote parent Snapshots

pub fn child_ids(&self) -> Result<Array<BnString>, ()>

List of ids of all remote child Snapshots

pub fn parents(&self) -> Result<Array<RemoteSnapshot>, ()>

List of all parent Snapshot objects

pub fn children(&self) -> Result<Array<RemoteSnapshot>, ()>

List of all child Snapshot objects

pub fn undo_entries(&self) -> Result<Array<RemoteUndoEntry>, ()>

Get the list of undo entries stored in this snapshot.

NOTE: If undo entries have not been pulled, they will be pulled upon calling this.

pub fn get_undo_entry_by_id( &self, id: RemoteUndoEntryId, ) -> Result<Option<Ref<RemoteUndoEntry>>, ()>

Get a specific Undo Entry in the Snapshot by its id

NOTE: If undo entries have not been pulled, they will be pulled upon calling this.

pub fn pull_undo_entries(&self) -> Result<(), ()>

Pull the list of Undo Entries from the Remote.

pub fn pull_undo_entries_with_progress<P: ProgressCallback>( &self, progress: P, ) -> Result<(), ()>

Pull the list of Undo Entries from the Remote.

pub fn create_undo_entry<S: BnStrCompatible>( &self, parent: Option<u64>, data: S, ) -> Result<Ref<RemoteUndoEntry>, ()>

Create a new Undo Entry in this snapshot.

pub fn finalize(&self) -> Result<(), ()>

Mark a snapshot as Finalized, committing it to the Remote, preventing future updates, and allowing snapshots to be children of it.

pub fn get_local_snapshot( &self, bv: &BinaryView, ) -> Result<Option<Ref<Snapshot>>, ()>

Get the local snapshot associated with a remote snapshot (if it exists)

pub fn analysis_cache_build_id(&self) -> u64

Trait Implementations

impl CoreArrayProvider for RemoteSnapshot

type Raw = *mut BNCollaborationSnapshot

type Context = ()

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

impl PartialEq for RemoteSnapshot

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl ToOwned for RemoteSnapshot

type Owned = Ref<RemoteSnapshot>

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.

impl Eq for RemoteSnapshot