Struct io_arrays::ArrayReader

pub struct ArrayReader { /* private fields */ }

Expand description

A random-access input source.

Implementations§

impl ArrayReader

pub fn file<Filelike: IntoFilelike + Read + Seek>(filelike: Filelike) -> Self

Convert a File into a ArrayReader.

pub fn bytes(bytes: &[u8]) -> Result<Self>

Copy a slice of bytes into a memory buffer to allow it to be accessed in the manner of an array.

Trait Implementations§

impl Array for &ArrayReader

fn metadata(&self) -> Result<Metadata>

Return the Metadata for the array. This is similar to std::fs::File::metadata, though it returns fewer fields since the underlying device may not be an actual filesystem inode.

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

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

impl Array for ArrayReader

fn metadata(&self) -> Result<Metadata>

Return the Metadata for the array. This is similar to std::fs::File::metadata, though it returns fewer fields since the underlying device may not be an actual filesystem inode.

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

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

impl AsFd for ArrayReader

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

Borrows the file descriptor. Read more

impl AsRawFd for ArrayReader

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor. Read more

impl Debug for ArrayReader

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

Formats the value using the given formatter. Read more

impl ReadAt for ArrayReader

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

Reads a number of bytes starting from a given offset. Read more

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

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

Is to read_vectored what read_at is to read.

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.

fn is_read_vectored_at(&self) -> bool

Determines if Self has an efficient read_vectored_at implementation.

fn read_via_stream_at(&self, offset: u64) -> Result<StreamReader>

Create a StreamReader which reads from the array at the given offset.

Auto Trait Implementations§

impl RefUnwindSafe for ArrayReader

impl Send for ArrayReader

impl Sync for ArrayReader

impl Unpin for ArrayReader

impl UnwindSafe for ArrayReader

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> AsFilelike for T
where T: AsFd,

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

Borrows the reference. Read more

fn as_filelike_view<Target>(&self) -> FilelikeView<'_, Target>
where Target: FilelikeViewType,

Return a borrowing view of a resource which dereferences to a &Target. Read more

impl<T> AsGrip for T
where T: AsFd,

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

Extracts the grip.

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

fn as_raw_filelike(&self) -> i32

Returns the raw value.

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

fn as_raw_grip(&self) -> i32

Extracts the raw grip.

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

fn as_raw_socketlike(&self) -> i32

Returns the raw value.

impl<T> AsSocketlike for T
where T: AsFd,

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

Borrows the reference.

fn as_socketlike_view<Target>(&self) -> SocketlikeView<'_, Target>
where Target: SocketlikeViewType,

Return a borrowing view of a resource which dereferences to a &Target. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> FileIoExt for T
where T: AsFilelike + IoExt,

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

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

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

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

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

Reads a number of bytes starting from a given offset. Read more

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

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

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

Is to read_vectored what read_at is to read.

fn is_read_vectored_at(&self) -> bool

Determines if this FileIoExt implementation has an efficient read_vectored_at implementation.

fn read_to_end_at(&self, buf: &mut Vec<u8>, offset: u64) -> Result<usize, Error>

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

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

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

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

Writes a number of bytes starting from a given offset. Read more

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

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

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

Is to write_vectored what write_at is to write.

fn is_write_vectored_at(&self) -> bool

Determines if this FileIoExt implementation has an efficient write_vectored_at implementation.

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

Writes a number of bytes at the end of a file. Read more

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

Is to append what write_vectored is to write.

fn is_append_vectored(&self) -> bool

Determines if this FileIoExt implementation has an efficient append_vectored implementation.

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

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

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

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

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

Is to read_exact_vectored what read_exact_at is to read_exact.

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

Is to write_all_vectored what write_all_at is to write_all.

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

Attempts to write an entire buffer at the end of a file. Read more

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

Is to append_all what write_all_vectored is to write_all.

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> GetSetFdFlags for T

fn get_fd_flags(&self) -> Result<FdFlags, Error>
where T: AsFilelike,

Query the “status” flags for the self file descriptor.

fn new_set_fd_flags(&self, fd_flags: FdFlags) -> Result<SetFdFlags<T>, Error>
where T: AsFilelike,

Create a new SetFdFlags value for use with set_fd_flags. Read more

fn set_fd_flags(&mut self, set_fd_flags: SetFdFlags<T>) -> Result<(), Error>
where T: AsFilelike,

Set the “status” flags for the self file descriptor. Read more

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> IoExt for T
where T: AsFilelike + AsSocketlike,

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

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

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

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

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

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

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

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

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

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

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

Read bytes from the current position without advancing the current position. Read more

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

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

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

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

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

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

fn flush(&self) -> Result<(), Error>

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

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

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

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

Is to read_vectored what read_exact is to read.

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

Is to write_vectored what write_all is to write.

impl<T> IsReadWrite for T
where T: AsFilelike,

fn is_read_write(&self) -> Result<(bool, bool), Error>

Test whether the handle is readable and/or writable.

impl<T> SetTimes for T
where T: AsFilelike,

fn set_times( &self, atime: Option<SystemTimeSpec>, mtime: Option<SystemTimeSpec> ) -> Result<(), Error>

Set the last access and last modification timestamps of an open file handle. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

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

Performs the conversion.