Crate android_sparse

An implementation of Android's sparse file format.

Enables reading and writing sparse images, as well as encoding from and decoding to raw images.

For consistency, this documentation refers to actual files on the file system as images. A raw image is an image in its original, uncompressed form. A sparse image is a sparse-encoded image. android-sparse implements means to convert raw to sparse images and vice versa, via an intermediate representation referred to as sparse file:

 -------                --------               --------
| raw   | --Encoder--> | sparse | <--Reader-- | sparse |
| image | <--Decoder-- | file   | --Writer--> | image  |
 -------                --------               --------

Re-exports

pub use file::File;

pub use read::Encoder;

pub use read::Reader;

pub use write::Decoder;

pub use write::Writer;

Modules

constants	Public constants.
file	Sparse file data structures.
read	Sparse image reading and raw image encoding.
result	Error handling with this crate's Result type.
write	Sparse image writing and decoding to raw images.