Struct cfb::Stream

pub struct Stream<'a, F: 'a> { /* fields omitted */ }

A stream entry in a compound file, much like a filesystem file.

Methods

impl<'a, F> Stream<'a, F>

fn len(&self) -> u64

Returns the current length of the stream, in bytes.

impl<'a, F: Read + Write + Seek> Stream<'a, F>

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

Truncates or extends the stream, updating the size of this stream to become size.

If size is less than the stream's current size, then the stream will be shrunk. If it is greater than the stream's current size, then the stream will be padded with zero bytes.

Does not change the current read/write position within the stream, unless the stream is truncated to before the current position, in which case the position becomes the new end of the stream.

Trait Implementations

impl<'a, F: Read + Seek> Seek for Stream<'a, F>

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

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

impl<'a, F: Read + Seek> Read for Stream<'a, F>

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.

unsafe fn initializer(&self) -> Initializer

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

Determines if this Reader can work with buffers of uninitialized memory.

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

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

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

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

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

Read the exact number of bytes required to fill buf.

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

Creates a "by reference" adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an [Iterator] over its bytes.

fn chars(self) -> Chars<Self>

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

the semantics of a partial read/write of where errors happen is currently unclear and may change

Transforms this Read instance to an [Iterator] over [char]s.

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

Creates an adaptor which will chain this stream with another.

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

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

impl<'a, F: Read + Write + Seek> Write for Stream<'a, F>

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

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

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

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

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

Attempts to write an entire buffer into this write.

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

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

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

Creates a "by reference" adaptor for this instance of Write.

impl<'a, F> Drop for Stream<'a, F>

fn drop(&mut self)

Executes the destructor for this type.