boxddd 0.3.0

Safe, ergonomic Rust bindings for Box3D
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

use crate::error::{Error, InvalidValueReason, Result};
use crate::types::{Pos, Quat, Transform, Vec3};
use std::ffi::CString;

#[inline]
pub(crate) const fn invalid(context: &'static str, reason: InvalidValueReason) -> Error {
    Error::InvalidValue { context, reason }
}

#[inline]
pub(crate) fn finite(context: &'static str, value: f32) -> Result<()> {
    if value.is_finite() {
        Ok(())
    } else {
        Err(invalid(context, InvalidValueReason::NonFinite))
    }
}

#[inline]
pub(crate) fn nonnegative(context: &'static str, value: f32) -> Result<()> {
    finite(context, value)?;
    if value >= 0.0 {
        Ok(())
    } else {
        Err(invalid(context, InvalidValueReason::OutOfRange))
    }
}

#[inline]
pub(crate) fn positive(context: &'static str, value: f32) -> Result<()> {
    finite(context, value)?;
    if value > 0.0 {
        Ok(())
    } else {
        Err(invalid(context, InvalidValueReason::OutOfRange))
    }
}

#[inline]
pub(crate) fn ordered(context: &'static str, lower: f32, upper: f32) -> Result<()> {
    finite(context, lower)?;
    finite(context, upper)?;
    if lower <= upper {
        Ok(())
    } else {
        Err(invalid(context, InvalidValueReason::InvalidCombination))
    }
}

#[inline]
pub(crate) fn vec3(context: &'static str, value: Vec3) -> Result<()> {
    if value.x.is_finite() && value.y.is_finite() && value.z.is_finite() {
        Ok(())
    } else {
        Err(invalid(context, InvalidValueReason::NonFinite))
    }
}

#[inline]
pub(crate) fn position(context: &'static str, value: Pos) -> Result<()> {
    if value.x.is_finite() && value.y.is_finite() && value.z.is_finite() {
        Ok(())
    } else {
        Err(invalid(context, InvalidValueReason::NonFinite))
    }
}

#[inline]
pub(crate) fn quaternion(context: &'static str, value: Quat) -> Result<()> {
    vec3(context, value.v)?;
    finite(context, value.s)?;
    let magnitude_squared =
        value.v.x * value.v.x + value.v.y * value.v.y + value.v.z * value.v.z + value.s * value.s;
    let tolerance = 20.0 * f32::EPSILON;
    if 1.0 - tolerance < magnitude_squared && magnitude_squared < 1.0 + tolerance {
        Ok(())
    } else {
        Err(invalid(context, InvalidValueReason::Malformed))
    }
}

#[inline]
pub(crate) fn transform(context: &'static str, value: Transform) -> Result<()> {
    vec3(context, value.p)?;
    quaternion(context, value.q)
}

pub(crate) fn c_string_value(context: &'static str, value: &str) -> Result<()> {
    count_i32(context, value.len())?;
    if value.as_bytes().contains(&0) {
        Err(invalid(context, InvalidValueReason::InteriorNul))
    } else {
        Ok(())
    }
}

pub(crate) fn c_string(context: &'static str, value: &str) -> Result<CString> {
    c_string_value(context, value)?;
    Ok(CString::new(value).expect("validated string contains an interior NUL"))
}

pub(crate) fn optional_c_string(
    context: &'static str,
    value: Option<&str>,
) -> Result<Option<CString>> {
    value.map(|value| c_string(context, value)).transpose()
}

pub(crate) fn count_i32(context: &'static str, value: usize) -> Result<i32> {
    i32::try_from(value).map_err(|_| invalid(context, InvalidValueReason::OutOfRange))
}