Struct fs_err::File

source · [−]

pub struct File { /* private fields */ }

Expand description

Wrapper around std::fs::File which adds more helpful information to all errors.

Implementations

source

impl File

Wrappers for methods from std::fs::File.

source

pub fn open(path: P) -> Result<Self, Error>where
P: Into<PathBuf>,

Wrapper for File::open.

source

pub fn create(path: P) -> Result<Self, Error>where
P: Into<PathBuf>,

Wrapper for File::create.

source

pub fn from_options(path: P, options: &OpenOptions) -> Result<Self, Error>where
P: Into<PathBuf>,

👎Deprecated: use fs_err::OpenOptions::open instead

Wrapper for OpenOptions::open.

This takes &std::fs::OpenOptions, not crate::OpenOptions.

source

impl File

Methods added by fs-err that are not available on std::fs::File.

source

pub fn from_parts(file: File, path: P) -> Selfwhere
P: Into<PathBuf>,

Creates a File from a raw file and its path.

source

pub fn into_parts(self) -> (File, PathBuf)

Extract the raw file and its path from this File

source

pub fn file(&self) -> &File

Returns a reference to the underlying std::fs::File.

source

pub fn file_mut(&mut self) -> &mut File

Returns a mutable reference to the underlying std::fs::File.

source

pub fn path(&self) -> &Path

Returns a reference to the path that this file was created with.

Trait Implementations

source

impl AsFd for File

Available on crate feature io_safety only.

source

fn as_fd(&self) -> BorrowedFd<'_>

Borrows the file descriptor. Read more

source

impl AsRawFd for File

source

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor. Read more

source

impl Debug for File

source

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

Formats the value using the given formatter. Read more

source

impl FileExt for File

source

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

Wrapper for FileExt::read_at

source

fn write_at(&self, buf: &[u8], offset: u64) -> Result<usize>

Wrapper for FileExt::write_at

source

impl From<File> for File

source

fn from(file: File) -> Self

Converts to this type from the input type.

source

impl From<File> for File

Available on crate feature tokio only.

source

fn from(f: File) -> Self

Converts to this type from the input type.

source

impl From<File> for OwnedFd

Available on crate feature io_safety only.

source

fn from(file: File) -> Self

Converts to this type from the input type.

source

impl IntoRawFd for File

source

fn into_raw_fd(self) -> RawFd

Consumes this object, returning the raw underlying file descriptor. Read more

source

impl<'a> Read for &'a File

source

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. Read more

source

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

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

source

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. Read more

1.0.0 · source

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. Read more

1.0.0 · source

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

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

1.6.0 · source

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

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

source

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

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

Pull some bytes from this source into the specified buffer. Read more

source

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

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

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

1.0.0 · source

fn by_ref(&mut self) -> &mut Selfwhere
Self: Sized,

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

1.0.0 · source

fn bytes(self) -> Bytes<Self>where
Self: Sized,

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

1.0.0 · source

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

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

1.0.0 · source

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

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

source

impl Read for File

source

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. Read more

source

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

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

source

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. Read more

1.0.0 · source

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. Read more

1.0.0 · source

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

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

1.6.0 · source

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

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

source

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

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

Pull some bytes from this source into the specified buffer. Read more

source

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

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

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

1.0.0 · source

fn by_ref(&mut self) -> &mut Selfwhere
Self: Sized,

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

1.0.0 · source

fn bytes(self) -> Bytes<Self>where
Self: Sized,

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

1.0.0 · source

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

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

1.0.0 · source

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

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

source

impl<'a> Seek for &'a File

source

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

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

1.55.0 · source

fn rewind(&mut self) -> Result<(), Error>

Rewind to the beginning of a stream. Read more

source

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). Read more

1.51.0 · source

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

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

source

impl Seek for File

source

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

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

1.55.0 · source

fn rewind(&mut self) -> Result<(), Error>

Rewind to the beginning of a stream. Read more

source

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). Read more

1.51.0 · source

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

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

source

impl<'a> Write for &'a File

source

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

Write a buffer into this writer, returning how many bytes were written. Read more

source

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize>

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

source

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

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

source

fn is_write_vectored(&self) -> bool

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

Determines if this Writer has an efficient write_vectored implementation. Read more

1.0.0 · source

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

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

source

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

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

Attempts to write multiple buffers into this writer. Read more

1.0.0 · source

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

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

1.0.0 · source

fn by_ref(&mut self) -> &mut Selfwhere
Self: Sized,

Creates a “by reference” adapter for this instance of Write. Read more

source

impl Write for File

source

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

Write a buffer into this writer, returning how many bytes were written. Read more

source

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize>

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

source

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

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

source

fn is_write_vectored(&self) -> bool

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

Determines if this Writer has an efficient write_vectored implementation. Read more

1.0.0 · source

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

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

source

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

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

Attempts to write multiple buffers into this writer. Read more

1.0.0 · source

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

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

1.0.0 · source

fn by_ref(&mut self) -> &mut Selfwhere
Self: Sized,

Creates a “by reference” adapter for this instance of Write. Read more

Auto Trait Implementations

impl RefUnwindSafe for File

impl Send for File

impl Sync for File

impl Unpin for File

impl UnwindSafe for File

Blanket Implementations

source

impl<T> Any for Twhere
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for Twhere
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T, U> TryFrom for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct fs_err::File

Implementations

impl File

pub fn open<P>(path: P) -> Result<Self, Error>where P: Into<PathBuf>,

pub fn create<P>(path: P) -> Result<Self, Error>where P: Into<PathBuf>,

pub fn from_options<P>(path: P, options: &OpenOptions) -> Result<Self, Error>where P: Into<PathBuf>,

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

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

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

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

pub fn try_clone(&self) -> Result<Self, Error>

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

impl File

pub fn from_parts<P>(file: File, path: P) -> Selfwhere P: Into<PathBuf>,

pub fn into_parts(self) -> (File, PathBuf)

pub fn file(&self) -> &File

pub fn file_mut(&mut self) -> &mut File

pub fn path(&self) -> &Path

Trait Implementations

impl AsFd for File

fn as_fd(&self) -> BorrowedFd<'_>

impl AsRawFd for File

fn as_raw_fd(&self) -> RawFd

impl Debug for File

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

impl FileExt for File

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

fn write_at(&self, buf: &[u8], offset: u64) -> Result<usize>

impl From<File> for File

fn from(file: File) -> Self

impl From<File> for File

fn from(f: File) -> Self

impl From<File> for OwnedFd

fn from(file: File) -> Self

impl IntoRawFd for File

fn into_raw_fd(self) -> RawFd

impl<'a> Read for &'a File

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

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

fn is_read_vectored(&self) -> bool

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

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

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

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

fn by_ref(&mut self) -> &mut Selfwhere Self: Sized,

fn bytes(self) -> Bytes<Self>where Self: Sized,

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

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

impl Read for File

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

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

fn is_read_vectored(&self) -> bool

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

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

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

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

fn by_ref(&mut self) -> &mut Selfwhere Self: Sized,

fn bytes(self) -> Bytes<Self>where Self: Sized,

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

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

impl<'a> Seek for &'a File

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

fn rewind(&mut self) -> Result<(), Error>

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

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

impl Seek for File

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

fn rewind(&mut self) -> Result<(), Error>

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

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

impl<'a> Write for &'a File

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

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize>

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

fn is_write_vectored(&self) -> bool

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

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

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

pub fn open<P>(path: P) -> Result<Self, Error>where
P: Into<PathBuf>,

pub fn create<P>(path: P) -> Result<Self, Error>where
P: Into<PathBuf>,

pub fn from_options<P>(path: P, options: &OpenOptions) -> Result<Self, Error>where
P: Into<PathBuf>,

pub fn from_parts<P>(file: File, path: P) -> Selfwhere
P: Into<PathBuf>,

fn by_ref(&mut self) -> &mut Selfwhere
Self: Sized,

fn bytes(self) -> Bytes<Self>where
Self: Sized,

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

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

fn by_ref(&mut self) -> &mut Selfwhere
Self: Sized,

fn bytes(self) -> Bytes<Self>where
Self: Sized,

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

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

fn by_ref(&mut self) -> &mut Selfwhere
Self: Sized,

fn by_ref(&mut self) -> &mut Selfwhere
Self: Sized,

impl<T> Any for Twhere
T: 'static + ?Sized,

impl<T> Borrow<T> for Twhere
T: ?Sized,

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

impl<T, U> Into<U> for Twhere
U: From<T>,

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,