• u8、u16、u32、u64、usize、u128
• i8、i16、i32、i64、isize、i128
• f32、f64
• bool、char
• NonZeroU*、NonZeroI*
• String、CompactString

CompactStringExt

宏

此包公开了一个宏 format_compact!，可以用于从参数创建 CompactString，就像使用 String 的 std::format! 宏创建字符串一样。

特性

compact_str 有以下可选特性

• serde实现了来自流行的serde crate 的Deserialize和Serialize trait，用于CompactString
• bytes提供了两种方法from_utf8_buf<B: Buf>(buf: &mut B)和from_utf8_buf_unchecked<B: Buf>(buf: &mut B)，允许从bytes::Buf创建一个CompactString
• markup实现了Render trait，因此CompactString可以作为HTML转义字符串在模板中使用
• diesel允许在diesel文本列中使用CompactStrings
• sqlx-mysql / sqlx-postgres / sqlx-sqlite允许在sqlx文本列中使用CompactStrings
• arbitrary实现了用于模糊测试的arbitrary::Arbitrary trait
• proptest实现了用于模糊测试的proptest::arbitrary::Arbitrary trait
• quickcheck实现了用于模糊测试的quickcheck::Arbitrary trait
• rkyv实现了rkyv::Archive、rkyv::Serialize和rkyv::Deserialize，用于快速零拷贝序列化，可以与序列化的字符串互换
• smallvec提供了into_bytes()方法，它允许您使用smallvec::SmallVec将CompactString转换为字节向量

工作原理

注意：本说明假设为64位架构，对于32位架构，通常将任何数字除以2。

通常字符串存储在堆上，因为它们是动态大小的。在Rust中，一个String由三个字段组成，每个字段的长度都是一个usize。例如，其布局类似于以下内容

String: [ ptr<8> | len<8> | cap<8> ]

1. ptr 是一个指向堆上存储字符串位置的指针
2. len 是字符串的长度
3. cap 是被指向的缓冲区的总容量

这导致在栈上存储了24个字节，每个字段8个字节。然后实际的字符串存储在堆上，通常还会额外分配内存以防止字符串更改时重新分配。

CompactString 的想法是，而不是在栈上存储元数据，只存储字符串本身。这样对于较短的字符串，我们可以节省一些内存，并且我们不需要在堆上进行分配，因此性能更高。一个 CompactString 限制为24字节（即 size_of::<String>()），所以它不会比 String 使用更多的内存。

CompactString 的内存布局看起来像这样

CompactString: [ 缓冲区<23> | len<1> ]

内存布局

内部，一个 CompactString 有两个变体

1. 内联，字符串长度 <= 24字节
2. 堆 分配，字符串长度 > 24字节

我们定义一个判别符（即跟踪我们使用哪个变体）在 最后一个字节中，具体来说

1. 0b11111110 - 所有1后跟0，表示 堆 分配
2. 0b11XXXXXX - 两个前导1，表示 内联，其中后跟的6位用于存储长度

并且一个 CompactString 的总体内存布局是

1. 堆: {ptr: 非空<u8>,len: usize,cap:容量}
2. 内联: {缓冲区: [u8; 24] }

_{两种变体都是24字节长}

对于 堆 分配的字符串，我们使用自定义的 HeapBuffer，它通常在栈上存储字符串的容量，但也可以选择在堆上存储。由于我们使用最后一个字节来跟踪判别符，所以我们只有7个字节来存储容量，或者在32位架构上只有3个字节。7个字节允许我们存储高达 2^56 的值，即64拍字节，而3个字节只允许我们存储高达 2^24 的值，即16兆字节。