Struct path_abs::FileEdit

pub struct FileEdit(_);

A read/write file handle with path() attached and improved error messages. Contains methods and trait implements for both readable and writeable files.

Examples

use std::io::{Read, Seek, Write, SeekFrom};
use path_abs::FileEdit;

let example = "example.txt";

let expected = "foo\nbar";
let mut edit = FileEdit::create(example)?;

let mut s = String::new();
edit.write_all(expected.as_bytes())?;
edit.seek(SeekFrom::Start(0))?;
edit.read_to_string(&mut s)?;

assert_eq!(expected, s);

Methods

impl FileEdit

pub fn open<P: AsRef<Path>>(path: P, options: OpenOptions) -> Result<FileEdit>

Open the file with the given OpenOptions but always sets read and write to true.

pub fn create<P: AsRef<Path>>(path: P) -> Result<FileEdit>

Open the file in editing mode, truncating it first if it exists and creating it otherwise.

pub fn append<P: AsRef<Path>>(path: P) -> Result<FileEdit>

Open the file for appending, creating it if it doesn't exist.

pub fn edit<P: AsRef<Path>>(path: P) -> Result<FileEdit>

Open the file for editing (reading and writing) but do not create it if it doesn't exist.

pub fn sync_all(&self) -> Result<()>

Attempts to sync all OS-internal metadata to disk.

This function will attempt to ensure that all in-core data reaches the filesystem before returning.

This function is identical to std::fs::File::sync_all except it has error messages which include the action and the path.

pub fn sync_data(&self) -> Result<()>

This function is similar to sync_all, except that it may not synchronize file metadata to the filesystem.

This function is identical to std::fs::File::sync_data except it has error messages which include the action and the path.

pub fn set_len(&mut self, size: u64) -> Result<()>

Truncates or extends the underlying file, updating the size of this file to become size.

This function is identical to std::fs::File::set_len except:

• It has error messages which include the action and the path.
• It takes &mut self instead of &self.

pub fn set_permissions(&mut self, perm: Permissions) -> Result<()>

Changes the permissions on the underlying file.

This function is identical to std::fs::File::set_permissions except:

• It has error messages which include the action and the path.
• It takes &mut self instead of &self.

pub fn read_string(&mut self) -> Result<String>

Read what remains of the file to a String.

pub fn write_str(&mut self, s: &str) -> Result<()>

Shortcut to self.write_all(s.as_bytes()) with slightly improved error message.

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

std::io::File::flush buth with the new error type.

Methods from Deref<Target = FileOpen>

pub fn path(&self) -> &PathFile

Get the path associated with the open file.

pub fn metadata(&self) -> Result<Metadata>

Queries metadata about the underlying file.

This function is identical to std::fs::File::metadata except it has error messages which include the action and the path.

pub fn try_clone(&self) -> Result<FileOpen>

Creates a new independently owned handle to the underlying file.

This function is identical to std::fs::File::try_clone except it has error messages which include the action and the path and it returns a FileOpen object.

Trait Implementations

impl Debug for FileEdit

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

Formats the value using the given formatter.

impl Read for FileEdit

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

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

unsafe fn initializer(&self) -> Initializer

🔬 This is a nightly-only experimental API. (read_initializer)

Determines if this Reader can work with buffers of uninitialized memory.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Read the exact number of bytes required to fill buf.

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Read.

Important traits for Bytes<R>

impl<R> Iterator for Bytes<R> where
    R: Read,  type Item = Result<u8, Error>;

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an [Iterator] over its bytes.

Important traits for Chars<R>

impl<R> Iterator for Chars<R> where
    R: Read,  type Item = Result<char, CharsError>;

fn chars(self) -> Chars<Self>

🔬 This is a nightly-only experimental API. (io)

the semantics of a partial read/write of where errors happen is currently unclear and may change

Transforms this Read instance to an [Iterator] over [char]s.

Important traits for Chain<T, U>

impl<T, U> Read for Chain<T, U> where
    T: Read,
    U: Read, 

fn chain<R>(self, next: R) -> Chain<Self, R> where
    R: Read, 

Creates an adaptor which will chain this stream with another.

Important traits for Take<T>

impl<T> Read for Take<T> where
    T: Read, 

fn take(self, limit: u64) -> Take<Self>

Creates an adaptor which will read at most limit bytes from it.

impl Write for FileEdit

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

Write a buffer into this object, returning how many bytes were written.

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

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this write.

fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Write.

impl Seek for FileEdit

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

Seek to an offset, in bytes, in a stream.

impl Deref for FileEdit

type Target = FileOpen

The resulting type after dereferencing.

fn deref(&self) -> &FileOpen

Dereferences the value.

impl Into<File> for FileEdit

Important traits for &'a File

impl<'a> Write for &'a Fileimpl Write for Fileimpl<'a> Read for &'a Fileimpl Read for File

fn into(self) -> File

Performs the conversion.