mayheap 0.2.0

An abtraction over alloc & heapless
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

#![no_std]
#![deny(
    missing_debug_implementations,
    nonstandard_style,
    rust_2018_idioms,
    missing_docs
)]
#![warn(unreachable_pub)]
#![allow(clippy::result_unit_err, clippy::missing_safety_doc)]
#![doc = include_str!("../README.md")]

#[cfg(all(not(feature = "alloc"), not(feature = "heapless")))]
compile_error!("Either the `alloc` or `heapless` feature must be enabled");

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

pub mod vec;
pub use vec::Vec;

pub mod string;
pub use string::String;

mod error;
pub use error::{Error, Result};

#[cfg(test)]
mod tests {
    #[cfg(feature = "serde")]
    #[test]
    fn serde() {
        let s = crate::String::<16>::try_from("hello").unwrap();
        let json = serde_json::to_string(&s).unwrap();
        assert_eq!(json, r#""hello""#);
        let s2: crate::String<16> = serde_json::from_str(&json).unwrap();
        assert_eq!(s, s2);

        let v = crate::Vec::<_, 10>::from_slice(&[1, 2, 3, 4, 5]).unwrap();
        let json = serde_json::to_string(&v).unwrap();
        assert_eq!(json, r#"[1,2,3,4,5]"#);
        let v2: crate::Vec<u8, 5> = serde_json::from_str(&json).unwrap();
        assert_eq!(v, v2);

        // Doesn't fit so should fail with `heapless` but not with `alloc`.
        let res = serde_json::from_str::<crate::Vec<u8, 1>>(&json);
        #[cfg(not(feature = "alloc"))]
        res.unwrap_err();
        #[cfg(feature = "alloc")]
        res.unwrap();
    }
}