pub struct Encoder<W, E = DefaultLz77Encoder> {
header: Header,
writer: Encoder<W, E>,
adler32: Adler32,
}
Expand description
ZLIB encoder.
Fields§
§header: Header
§writer: Encoder<W, E>
§adler32: Adler32
Implementations§
source§impl<W> Encoder<W, DefaultLz77Encoder>where
W: Write,
impl<W> Encoder<W, DefaultLz77Encoder>where W: Write,
sourcepub fn new(inner: W) -> Result<Self>
pub fn new(inner: W) -> Result<Self>
Makes a new encoder instance.
Encoded ZLIB stream is written to inner
.
Examples
use std::io::Write;
use libflate::zlib::Encoder;
let mut encoder = Encoder::new(Vec::new()).unwrap();
encoder.write_all(b"Hello World!").unwrap();
assert_eq!(encoder.finish().into_result().unwrap(),
vec![120, 156, 5, 192, 49, 13, 0, 0, 8, 3, 65, 43, 224, 6, 7, 24, 128,
237, 147, 38, 245, 63, 244, 230, 65, 181, 50, 215, 1, 28, 73, 4, 62]);
source§impl<W, E> Encoder<W, E>where
W: Write,
E: Lz77Encode,
impl<W, E> Encoder<W, E>where W: Write, E: Lz77Encode,
sourcepub fn with_options(inner: W, options: EncodeOptions<E>) -> Result<Self>
pub fn with_options(inner: W, options: EncodeOptions<E>) -> Result<Self>
Makes a new encoder instance with specified options.
Encoded ZLIB stream is written to inner
.
Examples
use std::io::Write;
use libflate::zlib::{Encoder, EncodeOptions};
let options = EncodeOptions::new().no_compression();
let mut encoder = Encoder::with_options(Vec::new(), options).unwrap();
encoder.write_all(b"Hello World!").unwrap();
assert_eq!(encoder.finish().into_result().unwrap(),
[120, 1, 1, 12, 0, 243, 255, 72, 101, 108, 108, 111, 32, 87, 111,
114, 108, 100, 33, 28, 73, 4, 62]);
sourcepub fn header(&self) -> &Header
pub fn header(&self) -> &Header
Returns the header of the ZLIB stream.
Examples
use libflate::zlib::{Encoder, Lz77WindowSize};
let encoder = Encoder::new(Vec::new()).unwrap();
assert_eq!(encoder.header().window_size(), Lz77WindowSize::KB32);
sourcepub fn finish(self) -> Finish<W, Error>
pub fn finish(self) -> Finish<W, Error>
Writes the ZLIB trailer and returns the inner stream.
Examples
use std::io::Write;
use libflate::zlib::Encoder;
let mut encoder = Encoder::new(Vec::new()).unwrap();
encoder.write_all(b"Hello World!").unwrap();
assert_eq!(encoder.finish().into_result().unwrap(),
vec![120, 156, 5, 192, 49, 13, 0, 0, 8, 3, 65, 43, 224, 6, 7, 24, 128,
237, 147, 38, 245, 63, 244, 230, 65, 181, 50, 215, 1, 28, 73, 4, 62]);
Note
If you are not concerned the result of this encoding,
it may be convenient to use AutoFinishUnchecked
instead of the explicit invocation of this method.
use std::io;
use libflate::finish::AutoFinishUnchecked;
use libflate::zlib::Encoder;
let plain = b"Hello World!";
let mut buf = Vec::new();
let mut encoder = AutoFinishUnchecked::new(Encoder::new(&mut buf).unwrap());
io::copy(&mut &plain[..], &mut encoder).unwrap();
sourcepub fn as_inner_ref(&self) -> &W
pub fn as_inner_ref(&self) -> &W
Returns the immutable reference to the inner stream.
sourcepub fn as_inner_mut(&mut self) -> &mut W
pub fn as_inner_mut(&mut self) -> &mut W
Returns the mutable reference to the inner stream.
sourcepub fn into_inner(self) -> W
pub fn into_inner(self) -> W
Unwraps the Encoder
, returning the inner stream.
Trait Implementations§
source§impl<W, E> Write for Encoder<W, E>where
W: Write,
E: Lz77Encode,
impl<W, E> Write for Encoder<W, E>where W: Write, E: Lz77Encode,
source§fn write(&mut self, buf: &[u8]) -> Result<usize>
fn write(&mut self, buf: &[u8]) -> Result<usize>
Write a buffer into this writer, returning how many bytes were written. Read more
source§fn flush(&mut self) -> Result<()>
fn flush(&mut self) -> Result<()>
Flush this output stream, ensuring that all intermediately buffered
contents reach their destination. Read more
source§fn is_write_vectored(&self) -> bool
fn is_write_vectored(&self) -> bool
🔬This is a nightly-only experimental API. (
can_vector
)1.0.0 · source§fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
Attempts to write an entire buffer into this writer. Read more
source§fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>
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. Read more
Auto Trait Implementations§
impl<W, E> RefUnwindSafe for Encoder<W, E>where E: RefUnwindSafe, W: RefUnwindSafe,
impl<W, E> Send for Encoder<W, E>where E: Send, W: Send,
impl<W, E> Sync for Encoder<W, E>where E: Sync, W: Sync,
impl<W, E> Unpin for Encoder<W, E>where E: Unpin, W: Unpin,
impl<W, E> UnwindSafe for Encoder<W, E>where E: UnwindSafe, W: UnwindSafe,
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more