lc-framework-sys 0.1.0+lc.2025

Low-level Rust bindings to the LC compression framework
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

//! [![CI Status]][workflow] [![MSRV]][repo] [![Latest Version]][crates.io]
//! [![Rust Doc Crate]][docs.rs] [![Rust Doc Main]][docs]
//!
//! [CI Status]: https://img.shields.io/github/actions/workflow/status/juntyr/lc-framework-rs/ci.yml?branch=main
//! [workflow]: https://github.com/juntyr/lc-framework-rs/actions/workflows/ci.yml?query=branch%3Amain
//!
//! [MSRV]: https://img.shields.io/badge/MSRV-1.85.0-blue
//! [repo]: https://github.com/juntyr/lc-framework-rs
//!
//! [Latest Version]: https://img.shields.io/crates/v/lc-framework-sys
//! [crates.io]: https://crates.io/crates/lc-framework-sys
//!
//! [Rust Doc Crate]: https://img.shields.io/docsrs/lc-framework-sys
//! [docs.rs]: https://docs.rs/lc-framework-sys/
//!
//! [Rust Doc Main]: https://img.shields.io/badge/docs-main-blue
//! [docs]: https://juntyr.github.io/lc-framework-rs/lc_framework_sys
//!
//! # lc-framework-sys
//!
//! Low-level Rust bindigs to the [LC] compression framework.
//!
//! [LC]: https://github.com/burtscher/LC-framework

#![allow(non_upper_case_globals)]
#![allow(non_camel_case_types)]
#![allow(non_snake_case)]
#![allow(missing_docs)]
#![allow(unsafe_code)]

use std::{
    ffi::{c_char, c_int, c_longlong, c_short},
    mem::size_of,
};
include!(concat!(env!("OUT_DIR"), "/bindings.rs"));

use lc_framework_src as _;

#[expect(clippy::manual_assert)]
pub const MAX_STAGES: usize = const {
    if max_stages < 0 {
        panic!("max_stages must not be negative");
    }

    let _: c_int = max_stages;

    if size_of::<c_int>() > size_of::<usize>() {
        panic!("max_stages might not fit into usize");
    }

    max_stages as usize
};

#[expect(clippy::manual_assert)]
const _: () = const {
    if CS % 8 != 0 {
        panic!("CS must be a multiple of 8")
    }
};

#[cfg(not(target_endian = "little"))]
compile_error!("LC framework only supports little-endian systems");

#[expect(clippy::manual_assert)]
const _: () = const {
    if size_of::<c_longlong>() != 8 {
        panic!("long long must be 8 bytes")
    }
};
#[expect(clippy::manual_assert)]
const _: () = const {
    if size_of::<c_int>() != 4 {
        panic!("int must be 4 bytes")
    }
};
#[expect(clippy::manual_assert)]
const _: () = const {
    if size_of::<c_short>() != 2 {
        panic!("short must be 2 bytes")
    }
};
#[expect(clippy::manual_assert)]
const _: () = const {
    if size_of::<c_char>() != 1 {
        panic!("char must be 1 byte")
    }
};