Struct LocalFile 

pub struct LocalFile { /* private fields */ }

Implementations

impl LocalFile

pub async fn open( path: impl AsRef<Path>, create: bool, write: bool, read: bool, ) -> Result<Self>

Opens up a file at path. Will create the file if `create is true, otherwise will fail if missing.

• Read permission is set by read.
• Write permission is set by write.

Internally, the path will be canonicalized to a resolved, absolute path that can be used as reference when examining the local file.

pub fn id(&self) -> u32

pub fn sig(&self) -> u32

pub fn handle(&self) -> LocalFileHandle

pub fn permissions(&self) -> LocalFilePermissions

pub fn path(&self) -> &Path

pub async fn rename( &mut self, sig: u32, to: impl AsRef<Path>, ) -> Result<u32, LocalFileError>

Renames a file (if possible) using its underlying path as the origin

pub async fn remove(&mut self, sig: u32) -> Result<(), LocalFileError>

Removes the file (if possible) using its underlying path

NOTE: If successful, this makes the local file reference no longer usable for the majority of its functionality

pub async fn read_all(&mut self, sig: u32) -> Result<Vec<u8>, LocalFileError>

Reads all contents of file from beginning to end

pub async fn write_all( &mut self, sig: u32, buf: &[u8], ) -> Result<(), LocalFileError>

Overwrites contents of file with provided contents

Trait Implementations

impl Debug for LocalFile

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

Formats the value using the given formatter.