Google Git
Sign in
fuchsia / third_party / github.com / rust-lang / rust-analyzer / 0fb3a130ceef2644f9da32e40a29189de54f11a6
commit0fb3a130ceef2644f9da32e40a29189de54f11a6[log] [tgz]
authorAnton Sol <AntonSol919@gmail.com>Wed Jan 31 17:40:49 2024 +0100
committerLukas Wirth <lukastw97@gmail.com>Wed Jan 31 18:59:27 2024 +0100
tree399624b6800ba966e550c91bc110611e222c648a
parenta063f407993b25611461653447cb9ede9e1af14d [diff]
reformat
1 file changed
tree: 399624b6800ba966e550c91bc110611e222c648a
  1. .github/
  2. src/
  3. tests/
  4. .gitignore
  5. bors.toml
  6. Cargo.toml
  7. LICENSE-APACHE
  8. LICENSE-MIT
  9. README.md
README.md

smol_str

CI Crates.io API reference

A SmolStr is a string type that has the following properties:

  • 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 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.