compact_str 0.9.0

A memory efficient string type that transparently stores strings on the stack, when possible
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

//! Implements the [`zeroize::Zeroize`] trait for [`CompactString`]

use crate::CompactString;
use zeroize::Zeroize;

#[cfg_attr(docsrs, doc(cfg(feature = "zeroize")))]
impl Zeroize for CompactString {
    fn zeroize(&mut self) {
        self.0.zeroize();
    }
}

#[cfg(test)]
mod tests {
    use std::string::ToString;

    use alloc::string::String;
    use test_strategy::proptest;

    use super::*;
    use crate::tests::rand_unicode;

    #[test]
    fn smoketest_zeroize() {
        let mut short = CompactString::from("hello");
        let mut control = short.as_str().to_string();
        short.zeroize();
        assert_eq!(short, "");
        control.zeroize();
        assert_eq!(control, short);

        let mut long = CompactString::from("I am a long string that will be on the heap");
        let mut control = long.as_str().to_string();
        long.zeroize();
        assert_eq!(long, "");
        assert!(long.is_heap_allocated());
        control.zeroize();
        assert_eq!(long, control);
    }

    #[proptest]
    #[cfg_attr(miri, ignore)]
    fn proptest_zeroize(#[strategy(rand_unicode())] s: String) {
        let mut compact = CompactString::new(s.clone());
        let mut control = s.clone();

        compact.zeroize();
        control.zeroize();

        assert_eq!(compact, control);
    }
}