arma-rs 1.12.1

Arma 3 Extensions in Rust
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

//! Feature flags for RV Extensions
//!
//! <https://community.bistudio.com/wiki/Extensions#Feature_Flags>

/// `RVExtensionContext` takes const void** as argument, instead of the default const char**, and arguments will be passed in their custom types
pub const RV_CONTEXT_ARGUMENTS_VOID_PTR: u64 = 1 << 0;
/// `RVExtensionContext` will retrieve a full Stacktrace
pub const RV_CONTEXT_STACK_TRACE: u64 = 1 << 1;
/// `RVExtensionContext` will not be called automatically. It must be manually requested via `RVExtensionRequestContext` (This improves performance when context is not needed).
pub const RV_CONTEXT_NO_DEFAULT_CALL: u64 = 1 << 2;

#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, PartialOrd, Ord, Hash)]
/// Feature flags for RV Extensions
pub struct FeatureFlags {
    context_stack_trace: bool,
}

impl FeatureFlags {
    /// Set the `context_stack_trace` flag
    pub const fn set_context_stack_trace(&mut self, value: bool) {
        self.context_stack_trace = value;
    }

    pub const fn with_context_stack_trace(mut self, value: bool) -> Self {
        self.set_context_stack_trace(value);
        self
    }

    /// Get the `context_stack_trace` flag
    pub const fn context_stack_trace(&self) -> bool {
        self.context_stack_trace
    }

    /// Create a new `FeatureFlags` from the given bits
    pub fn from_bits(bits: u64) -> Self {
        let mut flags = Self::default();
        flags.set_context_stack_trace(bits & RV_CONTEXT_STACK_TRACE != 0);
        flags
    }

    /// Get the bits of the `FeatureFlags`
    pub const fn as_bits(&self) -> u64 {
        let mut bits = RV_CONTEXT_NO_DEFAULT_CALL | RV_CONTEXT_ARGUMENTS_VOID_PTR;
        if self.context_stack_trace() {
            bits |= RV_CONTEXT_STACK_TRACE;
        }
        bits
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn default() {
        let flags = FeatureFlags::default();
        assert_eq!(
            flags.as_bits(),
            RV_CONTEXT_NO_DEFAULT_CALL | RV_CONTEXT_ARGUMENTS_VOID_PTR
        );
    }

    #[test]
    fn just_stack_trace() {
        let mut flags = FeatureFlags::default();
        flags.set_context_stack_trace(true);
        assert_eq!(
            flags.as_bits(),
            RV_CONTEXT_NO_DEFAULT_CALL | RV_CONTEXT_STACK_TRACE | RV_CONTEXT_ARGUMENTS_VOID_PTR
        );
    }
}