Struct flate2::write::GzEncoder [−][src]
A gzip streaming encoder
This structure exposes a Write
interface that will emit compressed data
to the underlying writer W
.
Examples
use std::io::prelude::*; use flate2::Compression; use flate2::write::GzEncoder; // Vec<u8> implements Write to print the compressed bytes of sample string let mut e = GzEncoder::new(Vec::new(), Compression::default()); e.write_all(b"Hello World").unwrap(); println!("{:?}", e.finish().unwrap());
Implementations
impl<W: Write> GzEncoder<W>
[src]
pub fn new(w: W, level: Compression) -> GzEncoder<W>ⓘ
[src]
Creates a new encoder which will use the given compression level.
The encoder is not configured specially for the emitted header. For
header configuration, see the GzBuilder
type.
The data written to the returned encoder will be compressed and then
written to the stream w
.
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 mutation of the writer may result in surprising results if this encoder is continued to be used.
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.
Errors
This function will perform I/O to complete this stream, and any I/O errors which occur will be returned from this function.
pub fn finish(self) -> Result<W>
[src]
Finish encoding this stream, returning the underlying writer once the encoding is done.
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
.
Errors
This function will perform I/O to complete this stream, and any I/O errors which occur will be returned from this function.
Trait Implementations
impl<W: Debug + Write> Debug for GzEncoder<W>
[src]
impl<W: Write> Drop for GzEncoder<W>
[src]
impl<R: Read + Write> Read for GzEncoder<R>
[src]
fn read(&mut self, buf: &mut [u8]) -> Result<usize>
[src]
pub fn read_vectored(
&mut self,
bufs: &mut [IoSliceMut<'_>]
) -> Result<usize, Error>
1.36.0[src]
&mut self,
bufs: &mut [IoSliceMut<'_>]
) -> Result<usize, Error>
pub fn is_read_vectored(&self) -> bool
[src]
pub unsafe fn initializer(&self) -> Initializer
[src]
pub fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>
1.0.0[src]
pub fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
1.0.0[src]
pub fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
1.6.0[src]
pub fn by_ref(&mut self) -> &mut Self
1.0.0[src]
pub fn bytes(self) -> Bytes<Self>
1.0.0[src]
pub fn chain<R>(self, next: R) -> Chain<Self, R> where
R: Read,
1.0.0[src]
R: Read,
pub fn take(self, limit: u64) -> Take<Self>
1.0.0[src]
impl<W: Write> Write for GzEncoder<W>
[src]
fn write(&mut self, buf: &[u8]) -> Result<usize>
[src]
fn flush(&mut self) -> Result<()>
[src]
pub fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>
1.36.0[src]
pub fn is_write_vectored(&self) -> bool
[src]
pub fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
1.0.0[src]
pub fn write_all_vectored(
&mut self,
bufs: &mut [IoSlice<'_>]
) -> Result<(), Error>
[src]
&mut self,
bufs: &mut [IoSlice<'_>]
) -> Result<(), Error>
pub fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>
1.0.0[src]
pub fn by_ref(&mut self) -> &mut Self
1.0.0[src]
Auto Trait Implementations
impl<W> RefUnwindSafe for GzEncoder<W> where
W: RefUnwindSafe,
W: RefUnwindSafe,
impl<W> Send for GzEncoder<W> where
W: Send,
W: Send,
impl<W> Sync for GzEncoder<W> where
W: Sync,
W: Sync,
impl<W> Unpin for GzEncoder<W> where
W: Unpin,
W: Unpin,
impl<W> UnwindSafe for GzEncoder<W> where
W: UnwindSafe,
W: UnwindSafe,
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,