Struct io_arrays::ArrayEditor

source ·

pub struct ArrayEditor { /* private fields */ }

Expand description

A random-access input source and output sink.

Implementations

source

impl ArrayEditor

source

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

Convert a File into a ArrayEditor.

source

pub fn anonymous() -> Result<Self>

Create a temporary anonymous resource which can be accessed in the manner of an array.

Trait Implementations

source

impl Array for &ArrayEditor

source

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

source

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

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

source

impl Array for ArrayEditor

source

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

source

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

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

source

impl AsFd for ArrayEditor

source

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

Borrows the file descriptor. Read more

source

impl AsRawFd for ArrayEditor

source

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor. Read more

source

impl Debug for ArrayEditor

source

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

Formats the value using the given formatter. Read more

source

impl ReadAt for ArrayEditor

source

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

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

source

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

source

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

Is to read_vectored what read_at is to read.

source

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.

source

fn is_read_vectored_at(&self) -> bool

Determines if Self has an efficient read_vectored_at implementation. Read more

source

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

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

source

impl WriteAt for &ArrayEditor

source

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

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

source

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

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

source

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

Is to write_vectored what write_at is to write.

source

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

Is to write_all_vectored what write_all_at is to write_all.

source

fn is_write_vectored_at(&self) -> bool

Determines if Self has an efficient write_vectored_at implementation. Read more

source

fn copy_from<R: ReadAt>(
 &mut self,
 offset: u64,
 input: &R,
 input_offset: u64,
 len: u64
) -> Result<u64>

Copy len bytes from input at input_offset to self at offset.

source

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

Truncates or extends the underlying array, updating the size of this array to become size. Read more

source

impl WriteAt for ArrayEditor

source

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

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

source

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

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

source

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

Is to write_vectored what write_at is to write.

source

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

Is to write_all_vectored what write_all_at is to write_all.

source

fn is_write_vectored_at(&self) -> bool

Determines if Self has an efficient write_vectored_at implementation. Read more

source

fn copy_from<R: ReadAt>(
 &mut self,
 offset: u64,
 input: &R,
 input_offset: u64,
 len: u64
) -> Result<u64>

Copy len bytes from input at input_offset to self at offset.

source

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

Truncates or extends the underlying array, updating the size of this array to become size. Read more

Auto Trait Implementations

impl RefUnwindSafe for ArrayEditor

impl Send for ArrayEditor

impl Sync for ArrayEditor

impl Unpin for ArrayEditor

impl UnwindSafe for ArrayEditor

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> AsFilelike for Twhere
T: AsFd,

source

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

Borrows the reference. Read more

source

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

source

impl<T> AsGrip for Twhere
T: AsFd,

source

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

Extracts the grip.

source

impl<T> AsRawFilelike for Twhere
T: AsRawFd,

source

fn as_raw_filelike(&self) -> i32

Returns the raw value.

source

impl<T> AsRawGrip for Twhere
T: AsRawFd,

source

fn as_raw_grip(&self) -> i32

Extracts the raw grip.

source

impl<T> AsRawSocketlike for Twhere
T: AsRawFd,

source

fn as_raw_socketlike(&self) -> i32

Returns the raw value.

source

impl<T> AsSocketlike for Twhere
T: AsFd,

source

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

Borrows the reference.

source

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

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> FileIoExt for Twhere
T: AsFilelike + IoExt,

source

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

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

source

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

source

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

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

source

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

source

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

Is to read_vectored what read_at is to read.

source

fn is_read_vectored_at(&self) -> bool

Determines if this Reader has an efficient read_vectored_at implementation. Read more

source

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

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

source

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

source

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

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

source

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

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

source

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

Is to write_vectored what write_at is to write.

source

fn is_write_vectored_at(&self) -> bool

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

source

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

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

source

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

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

source

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.

source

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.

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> GetSetFdFlags for T

source

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

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

source

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

source

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

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> IoExt for Twhere
T: AsFilelike + AsSocketlike,

source

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

source

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

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

source

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

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

source

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

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

source

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

source

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

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

source

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

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

source

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

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

source

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

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

source

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

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

source

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

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

source

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

Is to read_vectored what read_exact is to read.

source

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

Is to write_vectored what write_all is to write.

source

impl<T> IsReadWrite for Twhere
T: AsFilelike,

source

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

Test whether the handle is readable and/or writable.

source

impl<T> IsTerminal for Twhere
T: AsFilelike,

source

fn is_terminal(&self) -> bool

Test whether this output stream is attached to a terminal. Read more

impl<T> SetTimes for Twhere
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

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 io_arrays::ArrayEditor

Implementations

impl ArrayEditor

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

pub fn anonymous() -> Result<Self>

Trait Implementations

impl Array for &ArrayEditor

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

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

impl Array for ArrayEditor

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

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

impl AsFd for ArrayEditor

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

impl AsRawFd for ArrayEditor

fn as_raw_fd(&self) -> RawFd

impl Debug for ArrayEditor

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

impl ReadAt for ArrayEditor

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

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

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

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

fn is_read_vectored_at(&self) -> bool

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

impl WriteAt for &ArrayEditor

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

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

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

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

fn is_write_vectored_at(&self) -> bool

fn copy_from<R: ReadAt>( &mut self, offset: u64, input: &R, input_offset: u64, len: u64) -> Result<u64>

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

impl WriteAt for ArrayEditor

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

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

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

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

fn is_write_vectored_at(&self) -> bool

fn copy_from<R: ReadAt>( &mut self, offset: u64, input: &R, input_offset: u64, len: u64) -> Result<u64>

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

Auto Trait Implementations

impl RefUnwindSafe for ArrayEditor

impl Send for ArrayEditor

impl Sync for ArrayEditor

impl Unpin for ArrayEditor

impl UnwindSafe for ArrayEditor

Blanket Implementations

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

fn type_id(&self) -> TypeId

impl<T> AsFilelike for Twhere T: AsFd,

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

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

impl<T> AsGrip for Twhere T: AsFd,

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

impl<T> AsRawFilelike for Twhere T: AsRawFd,

fn as_raw_filelike(&self) -> i32

impl<T> AsRawGrip for Twhere T: AsRawFd,

fn as_raw_grip(&self) -> i32

impl<T> AsRawSocketlike for Twhere T: AsRawFd,

fn as_raw_socketlike(&self) -> i32

impl<T> AsSocketlike for Twhere T: AsFd,

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

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

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

fn borrow(&self) -> &T

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

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

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

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

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

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

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

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

fn is_read_vectored_at(&self) -> bool

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

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

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

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

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

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

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

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

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

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

fn copy_from<R: ReadAt>(
&mut self,
offset: u64,
input: &R,
input_offset: u64,
len: u64
) -> Result<u64>

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

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

fn copy_from<R: ReadAt>(
&mut self,
offset: u64,
input: &R,
input_offset: u64,
len: u64
) -> Result<u64>

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

impl<T> AsFilelike for Twhere
T: AsFd,

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

impl<T> AsGrip for Twhere
T: AsFd,

impl<T> AsRawFilelike for Twhere
T: AsRawFd,

impl<T> AsRawGrip for Twhere
T: AsRawFd,

impl<T> AsRawSocketlike for Twhere
T: AsRawFd,

impl<T> AsSocketlike for Twhere
T: AsFd,

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

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

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

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

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

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

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

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

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

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

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

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

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

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

impl<T> IsReadWrite for Twhere
T: AsFilelike,

impl<T> IsTerminal for Twhere
T: AsFilelike,

impl<T> SetTimes for Twhere
T: AsFilelike,

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

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

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