Struct File

pub struct File { /* private fields */ }

Implementations

impl File

pub fn branch(&self) -> &Branch

pub async fn parent(&self) -> Result<Directory>

pub fn len(&self) -> u64

Length of this file in bytes.

pub fn progress(&self) -> impl Future<Output = Result<u64>>

Sync progress of this file, that is, what part of this file (in bytes) is available locally. NOTE: The future returned from this function doesn’t borrow from self so it’s possible to drop the self before/while awaiting it. This is useful to avoid keeping the file lock while awaiting the result.

pub async fn read(&mut self, buffer: &mut [u8]) -> Result<usize>

Reads data from this file. Returns the number of bytes actually read.

pub async fn read_all(&mut self, buffer: &mut [u8]) -> Result<usize>

pub async fn read_to_end(&mut self) -> Result<Vec<u8>>

Read all data from this file from the current seek position until the end and return then in a Vec.

pub async fn write(&mut self, buffer: &[u8]) -> Result<usize>

Writes buffer into this file. Returns the number of bytes actually written.

pub async fn write_all(&mut self, buffer: &[u8]) -> Result<()>

pub fn seek(&mut self, pos: SeekFrom) -> u64

Seeks to an offset in the file.

pub fn truncate(&mut self, len: u64) -> Result<()>

Truncates the file to the given length.

pub async fn flush(&mut self) -> Result<()>

Atomically saves any pending modifications and updates the version vectors of this file and all its ancestors.

pub async fn copy_to_writer<W: AsyncWrite + Unpin>( &mut self, dst: &mut W, ) -> Result<()>

Copy the entire contents of this file into the provided writer (e.g. a file on a regular filesystem)

pub async fn fork(&mut self, dst_branch: Branch) -> Result<()>

Forks this file into the given branch. Ensure all its ancestor directories exist and live in the branch as well. Should be called before any mutable operation.

pub async fn version_vector(&self) -> Result<VersionVector>

Trait Implementations

impl Debug for File

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

Formats the value using the given formatter.