Struct RemoteFile

pub struct RemoteFile { /* private fields */ }

A remote project file. It controls the various snapshots and raw file contents associated with the analysis.

Implementations

impl RemoteFile

pub fn get_for_local_database( database: &Database, ) -> Result<Option<Ref<RemoteFile>>, ()>

Look up the remote File for a local database, or None if there is no matching remote File found. See RemoteFile::get_for_binary_view to load from a BinaryView.

pub fn get_for_binary_view( bv: &BinaryView, ) -> Result<Option<Ref<RemoteFile>>, ()>

Look up the RemoteFile for a local BinaryView, or None if there is no matching remote File found.

pub fn core_file(&self) -> Result<ProjectFile, ()>

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

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

pub fn folder(&self) -> Result<Option<Ref<RemoteFolder>>, ()>

Parent folder, if one exists. None if this is in the root of the project.

pub fn set_folder(&self, folder: Option<&RemoteFolder>) -> Result<(), ()>

Set the parent folder of a file.

pub fn set_metadata<S: BnStrCompatible>(&self, folder: S) -> Result<(), ()>

pub fn url(&self) -> BnString

Web API endpoint URL

pub fn chat_log_url(&self) -> BnString

Chat log API endpoint URL

pub fn user_positions_url(&self) -> BnString

pub fn id(&self) -> BnString

Unique ID

pub fn file_type(&self) -> RemoteFileType

All files share the same properties, but files with different types may make different uses of those properties, or not use some of them at all.

pub fn created(&self) -> SystemTime

Created date of the file

pub fn created_by(&self) -> BnString

pub fn last_modified(&self) -> SystemTime

Last modified of the file

pub fn last_snapshot(&self) -> SystemTime

Date of last snapshot in the file

pub fn last_snapshot_by(&self) -> BnString

Username of user who pushed the last snapshot in the file

pub fn last_snapshot_name(&self) -> BnString

pub fn hash(&self) -> BnString

Hash of file contents (no algorithm guaranteed)

pub fn name(&self) -> BnString

Displayed name of file

pub fn set_name<S: BnStrCompatible>(&self, name: S) -> Result<(), ()>

Set the description of the file. You will need to push the file to update the remote version.

pub fn description(&self) -> BnString

Desciprtion of the file

pub fn set_description<S: BnStrCompatible>( &self, description: S, ) -> Result<(), ()>

Set the description of the file. You will need to push the file to update the remote version.

pub fn metadata(&self) -> BnString

pub fn size(&self) -> u64

Size of raw content of file, in bytes

pub fn default_path(&self) -> BnString

Get the default filepath for a remote File. This is based off the Setting for collaboration.directory, the file’s id, the file’s project’s id, and the file’s remote’s id.

pub fn has_pulled_snapshots(&self) -> bool

If the file has pulled the snapshots yet

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

Get the list of snapshots in this file.

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

pub fn snapshot_by_id<S: BnStrCompatible>( &self, id: S, ) -> Result<Option<Ref<RemoteSnapshot>>, ()>

Get a specific Snapshot in the File by its id

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

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

Pull the list of Snapshots from the Remote.

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

Pull the list of Snapshots from the Remote.

pub fn create_snapshot<S, I>( &self, name: S, contents: &mut [u8], analysis_cache_contexts: &mut [u8], file: &mut [u8], parent_ids: I, ) -> Result<Ref<RemoteSnapshot>, ()>

where S: BnStrCompatible, I: IntoIterator, I::Item: BnStrCompatible,

Create a new snapshot on the remote (and pull it)

• name - Snapshot name
• contents - Snapshot contents
• analysis_cache_contents - Contents of analysis cache of snapshot
• file - New file contents (if contents changed)
• parent_ids - List of ids of parent snapshots (or empty if this is a root snapshot)

pub fn create_snapshot_with_progress<S, I, P>( &self, name: S, contents: &mut [u8], analysis_cache_contexts: &mut [u8], file: &mut [u8], parent_ids: I, progress: P, ) -> Result<Ref<RemoteSnapshot>, ()>

where S: BnStrCompatible, P: ProgressCallback, I: IntoIterator, I::Item: BnStrCompatible,

Create a new snapshot on the remote (and pull it)

• name - Snapshot name
• contents - Snapshot contents
• analysis_cache_contents - Contents of analysis cache of snapshot
• file - New file contents (if contents changed)
• parent_ids - List of ids of parent snapshots (or empty if this is a root snapshot)
• progress - Function to call on progress updates

pub fn delete_snapshot(&self, snapshot: &RemoteSnapshot) -> Result<(), ()>

pub fn request_user_positions(&self) -> BnString

pub fn request_chat_log(&self) -> BnString

pub fn download<S>(&self, db_path: S) -> Result<Ref<FileMetadata>, ()>

where S: BnStrCompatible,

Download a file from its remote, saving all snapshots to a database in the specified location. Returns a FileContext for opening the file later.

• db_path - File path for saved database
• progress_function - Function to call for progress updates

pub fn download_with_progress<S, F>( &self, db_path: S, progress_function: F, ) -> Result<Ref<FileMetadata>, ()>

where S: BnStrCompatible, F: ProgressCallback,

Download a file from its remote, saving all snapshots to a database in the specified location. Returns a FileContext for opening the file later.

• db_path - File path for saved database
• progress_function - Function to call for progress updates

pub fn download_database<S: BnStrCompatible>( &self, path: S, ) -> Result<Ref<FileMetadata>, ()>

Download a remote file and save it to a BNDB at the given path, returning the associated FileMetadata.

pub fn download_database_with_progress<S: BnStrCompatible>( &self, path: S, progress: impl ProgressCallback, ) -> Result<Ref<FileMetadata>, ()>

Download a remote file and save it to a BNDB at the given path.

pub fn sync<C: DatabaseConflictHandler, N: NameChangeset>( &self, database: &Database, conflict_handler: C, name_changeset: N, ) -> Result<(), ()>

Completely sync a file, pushing/pulling/merging/applying changes

• bv_or_db - Binary view or database to sync with
• conflict_handler - Function to call to resolve snapshot conflicts
• name_changeset - Function to call for naming a pushed changeset, if necessary

pub fn sync_with_progress<C: DatabaseConflictHandler, P: ProgressCallback, N: NameChangeset>( &self, database: &Database, conflict_handler: C, name_changeset: N, progress: P, ) -> Result<(), ()>

Completely sync a file, pushing/pulling/merging/applying changes

• bv_or_db - Binary view or database to sync with
• conflict_handler - Function to call to resolve snapshot conflicts
• name_changeset - Function to call for naming a pushed changeset, if necessary
• progress - Function to call for progress updates

pub fn pull<C, N>( &self, database: &Database, conflict_handler: C, name_changeset: N, ) -> Result<usize, ()>

where C: DatabaseConflictHandler, N: NameChangeset,

Pull updated snapshots from the remote. Merge local changes with remote changes and potentially create a new snapshot for unsaved changes, named via name_changeset.

• bv_or_db - Binary view or database to sync with
• conflict_handler - Function to call to resolve snapshot conflicts
• name_changeset - Function to call for naming a pushed changeset, if necessary

pub fn pull_with_progress<C, P, N>( &self, database: &Database, conflict_handler: C, name_changeset: N, progress: P, ) -> Result<usize, ()>

where C: DatabaseConflictHandler, P: ProgressCallback, N: NameChangeset,

Pull updated snapshots from the remote. Merge local changes with remote changes and potentially create a new snapshot for unsaved changes, named via name_changeset.

• bv_or_db - Binary view or database to sync with
• conflict_handler - Function to call to resolve snapshot conflicts
• name_changeset - Function to call for naming a pushed changeset, if necessary
• progress - Function to call for progress updates

pub fn push<P>(&self, database: &Database) -> Result<usize, ()>

where P: ProgressCallback,

Push locally added snapshots to the remote.

• bv_or_db - Binary view or database to sync with

pub fn push_with_progress<P>( &self, database: &Database, progress: P, ) -> Result<usize, ()>

where P: ProgressCallback,

Push locally added snapshots to the remote.

• bv_or_db - Binary view or database to sync with
• progress - Function to call for progress updates

Trait Implementations

impl CoreArrayProvider for RemoteFile

type Raw = *mut BNRemoteFile

type Context = ()

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

impl Debug for RemoteFile

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

Formats the value using the given formatter.

impl PartialEq for RemoteFile

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 RemoteFile

type Owned = Ref<RemoteFile>

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 RemoteFile