draco-oxide-core 0.1.0-alpha.7

Shared core for draco-oxide: the geometry/attribute data model, numeric primitives, and the compression algorithms shared between the encoder and decoder.
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

#[macro_export]
macro_rules! debug_write {
    ($msg:literal, $writer:expr) => {
        #[cfg(feature = "debug_format")]
        {
            for byte in $msg.as_bytes() {
                $writer.write_u8(*byte);
            }
        }
    };
}

#[macro_export]
macro_rules! debug_expect {
    ($msg:literal, $reader:expr) => {
        #[cfg(feature = "debug_format")]
        {
            for byte in $msg.as_bytes() {
                assert!(
                    *byte == $reader.read_u8().unwrap(),
                    "Expected {:?}, but did not match.",
                    $msg
                );
            }
        }
    };
}

/// Safety assertion guarding `unsafe` preconditions and internal invariants.
///
/// A failing safety assertion indicates a bug in this library, never a runtime or
/// input condition; it is not a hardening check. The checks run only in debug
/// builds, and only while the (default-on) `safety_assertions` feature is enabled
/// — i.e. `all(debug_assertions, feature = "safety_assertions")`. Release builds
/// never run them, and disabling the feature (`--no-default-features`) drops them
/// from debug builds too.
///
/// Like `debug_write!`/`debug_expect!`, the `feature = "safety_assertions"` cfg
/// resolves at the call site, so every crate invoking this macro must declare the
/// (default-on) `safety_assertions` feature (forwarding into core).
#[macro_export]
macro_rules! safety_assert {
    ($($arg:tt)*) => {
        #[cfg(all(debug_assertions, feature = "safety_assertions"))]
        {
            ::core::assert!($($arg)*);
        }
    };
}

/// `assert_eq!` counterpart of [`safety_assert!`]; see that macro for semantics.
#[macro_export]
macro_rules! safety_assert_eq {
    ($($arg:tt)*) => {
        #[cfg(all(debug_assertions, feature = "safety_assertions"))]
        {
            ::core::assert_eq!($($arg)*);
        }
    };
}