Struct path_abs::FileRead
[−]
[src]
pub struct FileRead(_);
A read-only file handle with path()
attached and improved error messages. Contains only the
methods and trait implementations which are allowed by a read-only file.
Examples
use std::io::Read; use path_abs::{PathFile, FileRead}; let example = "example.txt"; let file = PathFile::create(example)?; let expected = "foo\nbar"; file.write_str(expected)?; let mut read = FileRead::read(example)?; let mut s = String::new(); read.read_to_string(&mut s)?; assert_eq!(expected, s);
Methods
impl FileRead
[src]
pub fn read<P: AsRef<Path>>(path: P) -> Result<FileRead>
[src]
Open the file as read-only.
pub fn read_string(&mut self) -> Result<String>
[src]
Read what remains of the file to a String
.
Methods from Deref<Target = FileOpen>
pub fn path(&self) -> &PathFile
[src]
Get the path associated with the open file.
pub 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.
pub 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 FileRead
[src]
fn fmt(&self, f: &mut Formatter) -> Result
[src]
Formats the value using the given formatter. Read more
impl Read for FileRead
[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, 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
ⓘImportant traits for &'a mut Wfn by_ref(&mut self) -> &mut Self
1.0.0[src]
Creates a "by reference" adaptor for this instance of Read
. Read more
ⓘImportant traits for Bytes<R>fn bytes(self) -> Bytes<Self>
1.0.0[src]
Transforms this Read
instance to an [Iterator
] over its bytes. Read more
ⓘImportant traits for Chars<R>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
ⓘImportant traits for Chain<T, U>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
ⓘImportant traits for Take<T>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 FileRead
[src]
fn seek(&mut self, pos: SeekFrom) -> Result<u64>
[src]
Seek to an offset, in bytes, in a stream. Read more