Struct StreamWriter

pub struct StreamWriter<'a, F> { /* private fields */ }

Provides read/write access for a stream within an MSF (PDB) file.

Implementations

impl<'a, F> StreamWriter<'a, F>

pub fn len(&self) -> u32

The length in bytes of this stream. This will return zero for nil streams.

pub fn is_empty(&self) -> bool

Returns true if the stream is zero-length or is a nil stream.

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

where F: ReadAt + WriteAt,

Replaces the contents of a stream. The length of the stream is set to the length of data.

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

where F: ReadAt + WriteAt,

Writes data to a given position in the file.

This method exists to work around the limitation of WriteAt, which takes &self instead of &mut self.

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

where F: ReadAt + WriteAt,

Writes data to a given position in the file.

This method exists to work around the limitation of WriteAt, which takes &self instead of &mut self.

pub fn set_len(&mut self, len: u32) -> Result<()>

where F: ReadAt + WriteAt,

Sets the length of this stream, in bytes.

If the stream is a nil stream, this changes it to a non-nil stream, even if len is zero.

If you are writing data to a stream, try to avoid using set_len to preallocate storage. It will allocate pages (yay) but it will waste I/O time by writing zero-fill data to all of the pages. There is currently no optimized path for preallocating pages that relies on the underlying storage provide zero-filling pages.

If you are replacing the contents of a large stream, just write everything from page zero and then call set_len at the end of the write.

pub fn into_random(self) -> RandomStreamWriter<'a, F>

Converts this StreamWriter into a RandomStreamWriter.

Trait Implementations

impl<'a, F: ReadAt> Read for StreamWriter<'a, F>

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

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

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

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

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.

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

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

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

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

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

Reads the exact number of bytes required to fill buf.

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.

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

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

Reads the exact number of bytes required to fill cursor.

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

where Self: Sized,

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

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

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

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

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

where Self: Sized,

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

impl<'a, F: ReadAt> Seek for StreamWriter<'a, F>

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

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

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

Rewind to the beginning of a stream.

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

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

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

fn seek_relative(&mut self, offset: i64) -> Result<(), Error>

Seeks relative to the current position.

impl<'a, F: ReadAt + WriteAt> Write for StreamWriter<'a, F>

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

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

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

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

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

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

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.

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

Attempts to write an entire buffer into this writer.

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.

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

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

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

where Self: Sized,

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