Crate liblzmaCopy item path

LZMA/XZ encoding and decoding streams

This library is a binding to liblzma currently to provide LZMA and xz encoding/decoding streams. I/O streams are provided in the read, write, and bufread modules (same types, different bounds). Raw in-memory compression/decompression is provided via the stream module and contains many of the raw APIs in liblzma.

§Examples

use liblzma::read::{XzDecoder, XzEncoder};
use std::io::prelude::*;

// Round trip some bytes from a byte source, into a compressor, into a
// decompressor, and finally into a vector.
let data = "Hello, World!".as_bytes();
let compressor = XzEncoder::new(data, 9);
let mut decompressor = XzDecoder::new(compressor);

let mut contents = String::new();
decompressor.read_to_string(&mut contents).unwrap();
assert_eq!(contents, "Hello, World!");

§Static linking

You can enable static-linking using the static feature, so that the XZ library is not required at runtime:

liblzma = { version = "0.3", features = ["static"] }

§Multithreading

This crate optionally can support multithreading using the parallel feature of this crate:

liblzma = { version = "0.3", features = ["parallel"] }

§Async I/O

This crate optionally can support async I/O streams with the Tokio stack via the tokio feature of this crate:

liblzma = { version = "0.3", features = ["tokio"] }

All methods are internally capable of working with streams that may return ErrorKind::WouldBlock when they’re not ready to perform the particular operation.

Note that care needs to be taken when using these objects, however. The Tokio runtime, in particular, requires that data is fully flushed before dropping streams. For compatibility with blocking streams all streams are flushed/written when they are dropped, and this is not always a suitable time to perform I/O. If I/O streams are flushed before drop, however, then these operations will be a noop.