[][src]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[src]

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

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>[src]

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>[src]

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

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

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

pub fn sync_all(&self) -> Result<()>[src]

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<()>[src]

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<()>[src]

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<()>[src]

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>[src]

Read what remains of the file to a String.

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

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

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

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

Trait Implementations

impl From<FileEdit> for FileOpen[src]

impl From<FileEdit> for File[src]

impl AsRef<FileOpen> for FileEdit[src]

impl AsRef<File> for FileEdit[src]

impl Debug for FileEdit[src]

impl Borrow<FileOpen> for FileEdit[src]

impl Borrow<File> for FileEdit[src]

impl<'a> Borrow<FileOpen> for &'a FileEdit[src]

impl<'a> Borrow<File> for &'a FileEdit[src]

impl Write for FileEdit[src]

fn write_vectored(&mut self, bufs: &[IoSlice]) -> Result<usize, Error>1.36.0[src]

Like write, except that it writes from a slice of buffers. Read more

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

Attempts to write an entire buffer into this writer. Read more

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

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

fn by_ref(&mut self) -> &mut Self1.0.0[src]

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

impl Read for FileEdit[src]

fn read_vectored(&mut self, bufs: &mut [IoSliceMut]) -> Result<usize, Error>1.36.0[src]

Like read, except that it reads into a slice of buffers. Read more

unsafe fn initializer(&self) -> Initializer[src]

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

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

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

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

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

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

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

Read the exact number of bytes required to fill buf. Read more

fn by_ref(&mut self) -> &mut Self1.0.0[src]

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

fn bytes(self) -> Bytes<Self>1.0.0[src]

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

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

Creates an adaptor which will chain this stream with another. Read more

fn take(self, limit: u64) -> Take<Self>1.0.0[src]

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

impl Seek for FileEdit[src]

fn stream_len(&mut self) -> Result<u64, Error>[src]

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

Returns the length of this stream (in bytes). Read more

fn stream_position(&mut self) -> Result<u64, Error>[src]

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

Returns the current seek position from the start of the stream. Read more

Auto Trait Implementations

Blanket Implementations

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]