Trait system_interface::fs::FileIoExt

pub trait FileIoExt {
    pub fn advise(&self, offset: u64, len: u64, advice: Advice) -> Result<()>;
    pub fn allocate(&self, offset: u64, len: u64) -> Result<()>;
    pub fn read(&self, buf: &mut [u8]) -> Result<usize>;
    pub fn read_exact(&self, buf: &mut [u8]) -> Result<()>;
    pub fn read_at(&self, buf: &mut [u8], offset: u64) -> Result<usize>;
    pub fn read_exact_at(&self, buf: &mut [u8], offset: u64) -> Result<()>;
    pub fn read_vectored(&self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize>;
    pub fn read_to_end(&self, buf: &mut Vec<u8>) -> Result<usize>;
    pub fn read_to_string(&self, buf: &mut String) -> Result<usize>;
    pub fn bytes(self) -> Bytes<File>;
    pub fn take(self, limit: u64) -> Take<File>;
    pub fn write(&self, buf: &[u8]) -> Result<usize>;
    pub fn write_all(&self, buf: &[u8]) -> Result<()>;
    pub fn write_at(&self, buf: &[u8], offset: u64) -> Result<usize>;
    pub fn write_all_at(&self, buf: &[u8], offset: u64) -> Result<()>;
    pub fn write_vectored(&self, bufs: &[IoSlice<'_>]) -> Result<usize>;
    pub fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<()>;
    pub fn flush(&self) -> Result<()>;
    pub fn seek(&self, pos: SeekFrom) -> Result<u64>;
    pub fn stream_position(&self) -> Result<u64>;

    pub fn read_exact_vectored(&self, bufs: &mut [IoSliceMut<'_>]) -> Result<()> { ... }
    pub fn read_vectored_at(
        &self, 
        bufs: &mut [IoSliceMut<'_>], 
        offset: u64
    ) -> Result<usize> { ... }
    pub fn read_exact_vectored_at(
        &self, 
        bufs: &mut [IoSliceMut<'_>], 
        offset: u64
    ) -> Result<()> { ... }
    pub fn is_read_vectored_at(&self) -> bool { ... }
    pub fn write_all_vectored(&self, bufs: &mut [IoSlice<'_>]) -> Result<()> { ... }
    pub fn write_vectored_at(
        &self, 
        bufs: &[IoSlice<'_>], 
        offset: u64
    ) -> Result<usize> { ... }
    pub fn write_all_vectored_at(
        &self, 
        bufs: &mut [IoSlice<'_>], 
        offset: u64
    ) -> Result<()> { ... }
    pub fn is_write_vectored_at(&self) -> bool { ... }
}

extension trait for std::fs::File and cap_std::fs::File.

Required methods

pub fn advise(&self, offset: u64, len: u64, advice: Advice) -> Result<()>

Announce the expected access pattern of the data at the given offset.

pub fn allocate(&self, offset: u64, len: u64) -> Result<()>

Allocate space in the file, increasing the file size as needed, and ensuring that there are no holes under the given range.

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

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

This is similar to std::io::Read::read, except it takes self by immutable reference since the entire side effect is I/O.

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

Read the exact number of bytes required to fill buf.

This is similar to std::io::Read::read_exact, except it takes self by immutable reference since the entire side effect is I/O.

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

Reads a number of bytes starting from a given offset.

This is similar to std::os::unix::fs::FileExt::read_at, except it takes self by immutable reference since the entire side effect is I/O, and it's supported on non-Unix platforms including Windows.

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

Reads the exact number of byte required to fill buf from the given offset.

This is similar to std::os::unix::fs::FileExt::read_exact_at, except it takes self by immutable reference since the entire side effect is I/O, and it's supported on non-Unix platforms including Windows.

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

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

This is similar to std::io::Read::read_vectored, except it takes self by immutable reference since the entire side effect is I/O.

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

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

This is similar to std::io::Read::read_to_end, except it takes self by immutable reference since the entire side effect is I/O.

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

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

This is similar to std::io::Read::read_to_string, except it takes self by immutable reference since the entire side effect is I/O.

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

Transforms this FileIoExt instance to an Iterator over its bytes.

This is similar to Read::bytes, except it returns a io::Bytes<fs::File> instead of an io::Bytes::<Self>.

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

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

This is similar to Read::take, except it returns a io::Take<fs::File> instead of an io::Take::<Self>.

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

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

This is similar to std::io::Write::write, except it takes self by immutable reference since the entire side effect is I/O.

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

Attempts to write an entire buffer into this writer.

This is similar to std::io::Write::write_all, except it takes self by immutable reference since the entire side effect is I/O.

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

Writes a number of bytes starting from a given offset.

This is similar to std::os::unix::fs::FileExt::write_at, except it takes self by immutable reference since the entire side effect is I/O, and it's supported on non-Unix platforms including Windows.

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

Attempts to write an entire buffer starting from a given offset.

This is similar to std::os::unix::fs::FileExt::write_all_at, except it takes self by immutable reference since the entire side effect is I/O, and it's supported on non-Unix platforms including Windows.

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

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

This is similar to std::io::Write::write_vectored, except it takes self by immutable reference since the entire side effect is I/O.

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

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

This is similar to std::io::Write::write_fmt, except it takes self by immutable reference since the entire side effect is I/O.

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

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

This is similar to std::io::Write::flush, except it takes self by immutable reference since the entire side effect is I/O.

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

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

This is similar to std::io::Seek::seek, except it takes self by immutable reference since the entire side effect is I/O.

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

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

This is similar to std::io::Seek::stream_position, except it's available on Rust stable.

This may eventually be implemented by rust-lang/rust#62726.

Loading content...

Provided methods

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

Is to read_vectored what read_exact is to read.

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

Is to read_vectored what read_at is to read.

pub fn read_exact_vectored_at(
    &self,
    bufs: &mut [IoSliceMut<'_>],
    offset: u64
) -> Result<()>

Is to read_exact_vectored what read_exact_at is to read_exact.

pub fn is_read_vectored_at(&self) -> bool

Determines if this Reader has an efficient read_vectored_at implementation.

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

Is to write_vectored what write_all is to write.

pub fn write_vectored_at(
    &self,
    bufs: &[IoSlice<'_>],
    offset: u64
) -> Result<usize>

Is to write_vectored what write_at is to write.

pub fn write_all_vectored_at(
    &self,
    bufs: &mut [IoSlice<'_>],
    offset: u64
) -> Result<()>

Is to write_all_vectored what write_all_at is to write_all.

pub fn is_write_vectored_at(&self) -> bool

Determines if this Writer has an efficient write_vectored_at implementation.

Loading content...

Implementors

impl<T> FileIoExt for T where
    T: AsRawFd, 

Implement FileIoExt for any type which implements AsRawFd.

pub fn advise(&self, offset: u64, len: u64, advice: Advice) -> Result<()>

pub fn allocate(&self, offset: u64, len: u64) -> Result<()>

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

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

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

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

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

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

pub fn is_read_vectored_at(&self) -> bool

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

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

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

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

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

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

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

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

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

pub fn write_vectored_at(
    &self,
    bufs: &[IoSlice<'_>],
    offset: u64
) -> Result<usize>

pub fn is_write_vectored_at(&self) -> bool

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

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

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

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

Loading content...