Struct path_abs::FileEdit
[−]
[src]
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]
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.
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.
fn append<P: AsRef<Path>>(path: P) -> Result<FileEdit>
[src]
Open the file for appending, creating it if it doesn't exist.
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.
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.
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.
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
.
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
.
fn read_string(&mut self) -> Result<String>
[src]
Read what remains of the file to a String
.
fn write_str(&mut self, s: &str) -> Result<()>
[src]
Shortcut to self.write_all(s.as_bytes())
with slightly
improved error message.
fn flush(&mut self) -> Result<()>
[src]
std::io::File::flush
buth with the new error type.
Methods from Deref<Target = FileOpen>
fn path(&self) -> &PathFile
[src]
Get the path associated with the open file.
fn metadata(&self) -> Result<Metadata>
[src]
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.
fn try_clone(&self) -> Result<FileOpen>
[src]
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
[src]
impl Read for FileEdit
[src]
fn read(&mut self, buf: &mut [u8]) -> Result<usize>
[src]
Pull some bytes from this source into the specified buffer, returning how many bytes were read. Read more
unsafe fn initializer(&self) -> Initializer
[src]
read_initializer
)Determines if this Read
er 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, placing them into 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 Self
1.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 chars(self) -> Chars<Self>
[src]
🔬 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. Read more
fn chain<R>(self, next: R) -> Chain<Self, R> where
R: Read,
1.0.0[src]
R: Read,
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 Write for FileEdit
[src]
fn write(&mut self, buf: &[u8]) -> Result<usize>
[src]
Write a buffer into this object, returning how many bytes were written. Read more
fn flush(&mut self) -> Result<()>
[src]
Flush this output stream, ensuring that all intermediately buffered contents reach their destination. Read more
fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
1.0.0[src]
Attempts to write an entire buffer into this write. 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 Self
1.0.0[src]
Creates a "by reference" adaptor for this instance of Write
. Read more
impl Seek for FileEdit
[src]
fn seek(&mut self, pos: SeekFrom) -> Result<u64>
[src]
Seek to an offset, in bytes, in a stream. Read more