vexide-core 0.8.0

Low-level core functionality for vexide.
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

//! VEXos-related functionality.
//!
//! This module provides utilities for for interacting and retrieving information from VEXos.

use core::fmt;

use vex_sdk::vexSystemVersion;

/// A VEXos firmware version.
///
/// This type represents a version identifier for VEXos firmware. VEXos is versioned using a
/// slightly modified [semantic versioning] scheme. To check the version currently running on a
/// brain, use [`system_version`].
///
/// [semantic versioning]: https://semver.org/
///
/// This type implements `PartialOrd`, meaning it can be compared to other instances of itself.
///
/// # Example
///
/// ```
/// use vexide::os::{Version, system_version};
///
/// // VEXos 1.1.5b0
/// const VEXOS_1_1_5_0: Version = Version {
///     major: 1,
///     minor: 1,
///     build: 5,
///     beta: 0,
/// };
///
/// // Get the currently running VEXos version
/// let version = system_version();
///
/// if version < VEXOS_1_1_5_0 {
///     println!("Update your firmware!");
/// }
/// ```
#[derive(Debug, Clone, Copy, Eq, PartialEq, Ord, PartialOrd)]
pub struct Version {
    /// The major version
    pub major: u8,
    /// The minor version
    pub minor: u8,
    /// The build version
    pub build: u8,
    /// The beta version
    pub beta: u8,
}

impl fmt::Display for Version {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(
            f,
            "{}.{}.{}-b{}",
            self.major, self.minor, self.build, self.beta
        )
    }
}

/// Returns the currently running VEXos [firmware version] on a brain.
///
/// [firmware version]: Version
///
/// # Example
///
/// ```
/// use vexide::os::{Version, system_version};
///
/// // VEXos 1.1.5b0
/// const VEXOS_1_1_5_0: Version = Version {
///     major: 1,
///     minor: 1,
///     build: 5,
///     beta: 0,
/// };
///
/// // Get the currently running VEXos version
/// let version = system_version();
///
/// if version < VEXOS_1_1_5_0 {
///     println!("Update your firmware!");
/// }
/// ```
#[must_use]
pub fn system_version() -> Version {
    let version_bytes = unsafe { vexSystemVersion() }.to_be_bytes();

    Version {
        major: version_bytes[0],
        minor: version_bytes[1],
        build: version_bytes[2],
        beta: version_bytes[3],
    }
}