kstring 2.0.4

Key String: optimized for map keys
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

//! Key String: Optimized for map keys.
//!
//! # Examples
//!
//! String creation
//! ```rust
//! // Explicit
//! let literal = kstring::KString::from_static("literal");
//! // Implicit
//! let literal = kstring::KString::from("literal");
//!
//! // Explicit
//! let inline = kstring::KString::try_inline("stack").unwrap();
//! let inline = kstring::KString::from_ref("stack");
//!
//! let formatted: kstring::KStringCow = format!("Hello {} and {}", literal, inline).into();
//! ```
//!
//! # Background
//!
//! Considerations:
//! - Large maps
//! - Most keys live and drop without being used in any other way
//! - Most keys are relatively small (single to double digit bytes)
//! - Keys are immutable
//! - Allow zero-cost abstractions between structs and maps (e.g. no allocating
//!   when dealing with struct field names)
//!
//! Ramifications:
//! - Inline small strings rather than going to the heap.
//! - Preserve `&'static str` across strings ([`KString`]),
//!   references ([`KStringRef`]), and lifetime abstractions ([`KStringCow`]) to avoid
//!   allocating for struct field names.
//! - Use `Box<str>` rather than `String` to use less memory.
//!
//! # Feature Flags
//!
#![cfg_attr(feature = "document-features", doc = document_features::document_features!())]
#![cfg_attr(not(feature = "unsafe"), forbid(unsafe_code))]
#![cfg_attr(all(not(feature = "std"), not(test)), no_std)]
#![cfg_attr(docsrs, feature(doc_cfg))]
#![warn(clippy::print_stderr)]
#![warn(clippy::print_stdout)]
#![warn(clippy::std_instead_of_core)]
#![warn(clippy::std_instead_of_alloc)]

#[allow(unused_extern_crates)]
extern crate alloc;

mod stack;
mod string;
mod string_cow;
mod string_ref;

pub mod backend;

pub use stack::StackString;
pub use string::*;
pub use string_cow::*;
pub use string_ref::*;

#[cfg(test)]
mod test {
    #[test]
    fn test_size() {
        println!("String: {}", size_of::<crate::string::StdString>());
        println!("Box<str>: {}", size_of::<crate::backend::DefaultStr>());
        println!(
            "Box<Box<str>>: {}",
            size_of::<Box<crate::backend::DefaultStr>>()
        );
        println!("str: {}", size_of::<&'static str>());
        println!("Cow: {}", size_of::<alloc::borrow::Cow<'static, str>>());
    }
}

#[doc = include_str!("../README.md")]
#[cfg(doctest)]
pub struct ReadmeDoctests;