compression-rs 0.2.4

Safe Rust bindings for Apple's Compression and AppleArchive APIs on macOS
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113

#![cfg_attr(docsrs, feature(doc_cfg))]
#![allow(
    clippy::doc_markdown,
    clippy::missing_const_for_fn,
    clippy::missing_errors_doc,
    clippy::module_name_repetitions,
    clippy::must_use_candidate,
    clippy::use_self
)]
#![doc = include_str!("../README.md")]

#[cfg(not(target_os = "macos"))]
compile_error!("compression only supports macOS");

mod aa_archive_stream;
mod aa_byte_stream;
mod aa_entry_blob;
mod aa_entry_stream;
mod aa_field_key;
mod aa_header;
mod aea;
mod compression_decode;
mod compression_encode;
mod compression_stream;
mod error;
mod ffi;
/// Wraps the raw `compression.h` and AppleArchive FFI surface.
#[cfg(feature = "raw-ffi")]
pub mod raw_ffi;
pub(crate) mod util;

pub use aa_archive_stream::{
    ArchiveStream, CustomArchiveStreamCallbacks, EntryMessageData, EntryMessageEvent,
    EntryMessageHandler,
};
pub use aa_byte_stream::{
    ArchiveCompressionAlgorithm, ArchiveFlags, ByteStream, CustomByteStreamCallbacks,
    DEFAULT_FILE_MODE, OPEN_CREATE, OPEN_READ_ONLY, OPEN_READ_WRITE, OPEN_TRUNCATE,
    OPEN_WRITE_ONLY,
};
pub use aa_entry_blob::{
    AccessControlEntry, AceFlagSet, AcePermSet, AceQualifierType, AceTag, EntryAclBlob,
    EntryXatBlob, NamedBlobEntry,
};
pub use aa_entry_stream::{EntryAttributes, EntryMessage, PathList};
pub use aa_field_key::{FieldKey, FieldKeySet};
pub use aa_header::{
    BlobDescription, EntryType, FieldType, HashFunction, HashValue, Header, HeaderFieldValue,
    Timespec,
};
pub use aea::{
    AeaAuthData, AeaChecksumMode, AeaCiphersuite, AeaContext, AeaContextField,
    AeaContextFieldRepresentation, AeaEncryptionMode, AeaPadding, AeaProfile, AeaSignatureMode,
};
pub use compression_decode::{
    compression_decode_buffer, compression_decode_scratch_buffer_size, decompress,
};
pub use compression_encode::{
    compress, compression_encode_buffer, compression_encode_scratch_buffer_size,
};
pub use compression_stream::{CompressionStream, Decoder, Encoder, StreamOperation};
pub use error::{CompressionError, Result};

/// Wraps `compression_algorithm` values from `compression.h`.
#[derive(Clone, Copy, Debug, Eq, PartialEq, Hash)]
pub enum Algorithm {
    /// Wraps `COMPRESSION_LZ4`.
    Lz4,
    /// Wraps `COMPRESSION_ZLIB`.
    Zlib,
    /// Wraps `COMPRESSION_LZMA`.
    Lzma,
    /// Wraps `COMPRESSION_LZ4_RAW`.
    Lz4Raw,
    /// Wraps `COMPRESSION_BROTLI`.
    Brotli,
    /// Wraps `COMPRESSION_LZFSE`.
    Lzfse,
    /// Wraps `COMPRESSION_LZBITMAP`.
    Lzbitmap,
}

impl Algorithm {
    /// Wraps the streaming-capable `compression_algorithm` set.
    pub const ALL: [Self; 5] = [Self::Lz4, Self::Zlib, Self::Lzma, Self::Brotli, Self::Lzfse];
    /// Wraps the buffer-capable `compression_algorithm` set.
    pub const BUFFER_ALL: [Self; 7] = [
        Self::Lz4,
        Self::Zlib,
        Self::Lzma,
        Self::Lz4Raw,
        Self::Brotli,
        Self::Lzfse,
        Self::Lzbitmap,
    ];

    /// Wraps stream support for `compression_stream_*` entry points.
    pub const fn supports_streams(self) -> bool {
        !matches!(self, Self::Lz4Raw | Self::Lzbitmap)
    }

    pub(crate) const fn as_raw(self) -> u32 {
        match self {
            Self::Lz4 => 0x100,
            Self::Zlib => 0x205,
            Self::Lzma => 0x306,
            Self::Lz4Raw => 0x101,
            Self::Brotli => 0xB02,
            Self::Lzfse => 0x801,
            Self::Lzbitmap => 0x702,
        }
    }
}