Struct bzip2::write::BzEncoder
[−]
[src]
pub struct BzEncoder<W: Write> { /* fields omitted */ }
A compression stream which will have uncompressed data written to it and will write compressed data to an output stream.
Methods
impl<W: Write> BzEncoder<W>
[src]
ⓘImportant traits for BzEncoder<W>pub fn new(obj: W, level: Compression) -> BzEncoder<W>
[src]
Create a new compression stream which will compress at the given level to write compress output to the give output stream.
pub fn get_ref(&self) -> &W
[src]
Acquires a reference to the underlying writer.
pub fn get_mut(&mut self) -> &mut W
[src]
Acquires a mutable reference to the underlying writer.
Note that mutating the output/input state of the stream may corrupt this object, so care must be taken when using this method.
pub fn try_finish(&mut self) -> Result<()>
[src]
Attempt to finish this output stream, writing out final chunks of data.
Note that this function can only be used once data has finished being
written to the output stream. After this function is called then further
calls to write
may result in a panic.
Panics
Attempts to write data to this stream may result in a panic after this function is called.
pub fn finish(self) -> Result<W>
[src]
Consumes this encoder, flushing the output stream.
This will flush the underlying data stream and then return the contained writer if the flush succeeded.
Note that this function may not be suitable to call in a situation where
the underlying stream is an asynchronous I/O stream. To finish a stream
the try_finish
(or shutdown
) method should be used instead. To
re-acquire ownership of a stream it is safe to call this method after
try_finish
or shutdown
has returned Ok
.
pub fn total_out(&self) -> u64
[src]
Returns the number of bytes produced by the compressor
Note that, due to buffering, this only bears any relation to
total_in()
after a call to flush()
. At that point,
total_out() / total_in()
is the compression ratio.
pub fn total_in(&self) -> u64
[src]
Returns the number of bytes consumed by the compressor (e.g. the number of bytes written to this stream.)
Trait Implementations
impl<W: Write> Write for BzEncoder<W>
[src]
fn write(&mut self, data: &[u8]) -> Result<usize>
[src]
Write a buffer into this object, returning how many bytes were written. Read more
fn flush(&mut self) -> Result<()>
[src]
Flush this output stream, ensuring that all intermediately buffered contents reach their destination. Read more
fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
1.0.0[src]
Attempts to write an entire buffer into this write. Read more
fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>
1.0.0[src]
Writes a formatted string into this writer, returning any error encountered. Read more
fn by_ref(&mut self) -> &mut Self
1.0.0[src]
Creates a "by reference" adaptor for this instance of Write
. Read more
impl<W: Read + Write> Read for BzEncoder<W>
[src]
fn read(&mut self, buf: &mut [u8]) -> Result<usize>
[src]
Pull some bytes from this source into the specified buffer, returning how many bytes were read. Read more
unsafe fn initializer(&self) -> Initializer
[src]
read_initializer
)Determines if this Read
er can work with buffers of uninitialized memory. Read more
fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>
1.0.0[src]
Read all bytes until EOF in this source, placing them into buf
. Read more
fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
1.0.0[src]
Read all bytes until EOF in this source, appending them to buf
. Read more
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
1.6.0[src]
Read the exact number of bytes required to fill buf
. Read more
fn by_ref(&mut self) -> &mut Self
1.0.0[src]
Creates a "by reference" adaptor for this instance of Read
. Read more
fn bytes(self) -> Bytes<Self>
1.0.0[src]
Transforms this Read
instance to an [Iterator
] over its bytes. Read more
fn chars(self) -> Chars<Self>
[src]
🔬 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. Read more
fn chain<R>(self, next: R) -> Chain<Self, R> where
R: Read,
1.0.0[src]
R: Read,
Creates an adaptor which will chain this stream with another. Read more
fn take(self, limit: u64) -> Take<Self>
1.0.0[src]
Creates an adaptor which will read at most limit
bytes from it. Read more