diff options
Diffstat (limited to 'vendor/smol_str/README.md')
| -rw-r--r-- | vendor/smol_str/README.md | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/vendor/smol_str/README.md b/vendor/smol_str/README.md new file mode 100644 index 000000000..2e61b9ee4 --- /dev/null +++ b/vendor/smol_str/README.md @@ -0,0 +1,28 @@ +# smol_str + +[](https://github.com/rust-analyzer/smol_str/actions?query=branch%3Amaster+workflow%3ACI) +[](https://crates.io/crates/smol_str) +[](https://docs.rs/smol_str/) + + +A `SmolStr` is a string type that has the following properties: + +* `size_of::<SmolStr>() == size_of::<String>()` +* `Clone` is `O(1)` +* Strings are stack-allocated if they are: + * Up to 22 bytes long + * Longer than 22 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 + +Unlike `String`, however, `SmolStr` is immutable. The primary use case for +`SmolStr` is a good enough default storage for tokens of typical programming +languages. Strings consisting of a series of newlines, followed by a series of +whitespace are a typical pattern in computer programs because of indentation. +Note that a specialized interner might be a better solution for some use cases. + +## MSRV Policy + +Minimal Supported Rust Version: latest stable. + +Bumping MSRV is not considered a semver-breaking change. |