hadris-common 0.2.0

Common types and functions used by Hadris
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

//! Common types and functions used by Hadris

#![no_std]

#[cfg(feature = "alloc")]
extern crate alloc;

#[cfg(feature = "std")]
extern crate std;

/// Algorithms (requires std for CRC and random)
#[cfg(feature = "std")]
pub mod alg;
/// Strings (requires alloc for String/Vec)
#[cfg(feature = "alloc")]
pub mod str;
/// Types
pub mod types;

/// A generic boot sector that informs the user they are loading the image incorrectly.
///
/// This is generated using the code in the `boot_sector` directory. See the README for more information.
/// Currently this is required to be maually compiled, and tested.
/// TODO: Make this a build script that generates the binary, and verify with a static analysis tool.
pub static BOOT_SECTOR_BIN: &[u8] = include_bytes!("boot_sector.bin");

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

    static_assertions::const_assert!(BOOT_SECTOR_BIN.len() == 512);
}