Unnamed repository; edit this file 'description' to name the repository.
Diffstat (limited to 'lib/smol_str/README.md')
| -rw-r--r-- | lib/smol_str/README.md | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/lib/smol_str/README.md b/lib/smol_str/README.md index 5e3506846f..ce16759e81 100644 --- a/lib/smol_str/README.md +++ b/lib/smol_str/README.md @@ -7,13 +7,14 @@ A `SmolStr` is a string type that has the following properties: -* `size_of::<SmolStr>() == 24 (therefore == size_of::<String>() on 64 bit platforms) +* `size_of::<SmolStr>() == 24` (therefore `== size_of::<String>()` on 64 bit platforms) * `Clone` is `O(1)` * Strings are stack-allocated if they are: * Up to 23 bytes long * Longer than 23 bytes, but substrings of `WS` (see `src/lib.rs`). Such strings consist solely of consecutive newlines, followed by consecutive spaces * If a string does not satisfy the aforementioned conditions, it is heap-allocated +* Additionally, a `SmolStr` can be explicitly created from a `&'static str` without allocation Unlike `String`, however, `SmolStr` is immutable. The primary use case for `SmolStr` is a good enough default storage for tokens of typical programming |