Function download_file_with_progress

rust/src/collaboration/sync.rs:61–79

TODO: AsRef Download a file from its remote, saving all snapshots to a database in the specified location. Returns a FileContext for opening the file later. `file` - Remote File to download and open `db_path` - File path for saved database `progress` - Function to call for progress updates

(
    file: &RemoteFile,
    db_path: S,
    mut progress: F,
)

/// * `db_path` - File path for saved database
/// * `progress` - Function to call for progress updates
pub fn download_file_with_progress<S: BnStrCompatible, F: ProgressCallback>(
    file: &RemoteFile,
    db_path: S,
    mut progress: F,
) -> Result<Ref<FileMetadata>, ()> {
    let db_path = db_path.into_bytes_with_nul();
    let result = unsafe {
        BNCollaborationDownloadFile(
            file.handle.as_ptr(),
            db_path.as_ref().as_ptr() as *const c_char,
            Some(F::cb_progress_callback),
            &mut progress as *mut F as *mut c_void,
        )
    };
    let success = !result.is_null();
    success
        .then(|| unsafe { Ref::new(FileMetadata::from_raw(result)) })
        .ok_or(())
}

/// Upload a file, with database, to the remote under the given project
///