Struct path_abs::FileRead

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::open(example)?;
let mut s = String::new();
read.read_to_string(&mut s)?;
assert_eq!(expected, s);

Implementations

impl FileRead

pub fn open<P: AsRef<Path>>(path: P) -> Result<FileRead>

Open the file as read-only.

pub fn path(&self) -> &PathFile

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

Read what remains of the file to a String.

Trait Implementations

impl AsRef<File> for FileRead

fn as_ref(&self) -> &File

Performs the conversion.

impl AsRef<FileOpen> for FileRead

fn as_ref(&self) -> &FileOpen

Performs the conversion.

impl Borrow<File> for FileRead

fn borrow(&self) -> &File

Immutably borrows from an owned value.

impl<'a> Borrow<File> for &'a FileRead

fn borrow(&self) -> &File

Immutably borrows from an owned value.

impl Borrow<FileOpen> for FileRead

fn borrow(&self) -> &FileOpen

Immutably borrows from an owned value.

impl<'a> Borrow<FileOpen> for &'a FileRead

fn borrow(&self) -> &FileOpen

Immutably borrows from an owned value.

impl Debug for FileRead

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

Formats the value using the given formatter.

impl From<FileRead> for FileOpen

fn from(orig: FileRead) -> FileOpen

Performs the conversion.

impl Read for FileRead

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.

pub fn read_vectored(
    &mut self,
    bufs: &mut [IoSliceMut<'_>]
) -> Result<usize, Error>

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

pub fn is_read_vectored(&self) -> bool

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

Determines if this Reader has an efficient read_vectored implementation.

pub 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.

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

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

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

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

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

Read the exact number of bytes required to fill buf.

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

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

pub fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an Iterator over its bytes.

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

Creates an adaptor which will chain this stream with another.

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

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

impl Seek for FileRead

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

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

pub fn stream_len(&mut self) -> Result<u64, Error>

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

Returns the length of this stream (in bytes).

pub fn stream_position(&mut self) -> Result<u64, Error>

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