Skip to main content

Crate lzvn

Crate lzvn 

Source
Expand description

Safe, clean-room LZVN encoding and decoding primitives.

The crate currently provides safe Rust support for raw LZVN streams and Apple wrappers such as bvxn and decmpfs, with no unsafe code.

Re-exports§

pub use raw::RawDecoder;
pub use raw::RawEncoder;
pub use apple::bvxn::BVXN_MAGIC;
pub use apple::bvxn::BvxnDecoder;
pub use apple::bvxn::BvxnEncoder;
pub use apple::bvxn::BvxnHeader;
pub use apple::bvxn::parse_header as parse_bvxn_header;
pub use apple::fs::decmpfs::DECMPFS_CHUNK_SIZE;
pub use apple::fs::decmpfs::DECMPFS_HEADER_LEN;
pub use apple::fs::decmpfs::DECMPFS_MAGIC;
pub use apple::fs::decmpfs::DECMPFS_MAX_XATTR_DATA_SIZE;
pub use apple::fs::decmpfs::DECMPFS_MAX_XATTR_SIZE;
pub use apple::fs::decmpfs::DecmpfsCompressionType;
pub use apple::fs::decmpfs::DecmpfsHeader;
pub use apple::fs::decmpfs::EncodedDecmpfs;
pub use apple::fs::decmpfs::parse_header as parse_decmpfs_header;

Modules§

apple
Apple-specific LZVN containers.
raw
Raw LZVN stream encoding and decoding.

Structs§

StreamProgress
Progress information returned by an incremental encoder or decoder step.

Enums§

Error
Errors produced while encoding or decoding raw LZVN streams and Apple wrappers such as bvxn and decmpfs.
StreamStatus
Status returned by an incremental encoder or decoder step.

Functions§

decode_bvxn
Decode an Apple bvxn block into a newly allocated buffer.
decode_bvxn_into
Decode an Apple bvxn block into an existing output buffer.
decode_decmpfs
Decode an Apple decmpfs wrapper into a newly allocated buffer.
decode_decmpfs_into
Decode an Apple decmpfs wrapper into an existing output buffer.
decode_raw
Decode a raw LZVN stream into a newly allocated buffer.
decode_raw_into
Decode a raw LZVN stream into an existing output buffer.
encode_bvxn
Encode bytes as an Apple bvxn block.
encode_decmpfs
Encode bytes as an Apple decmpfs LZVN wrapper.
encode_raw
Encode bytes as a raw LZVN stream.

Type Aliases§

Result
Result alias used by this crate.