Google Git
Sign in
fuchsia / third_party / github.com / rust-lang / rust-analyzer / eb00f33ab4f409020d47acc2eba17d6bbb69e3be
commiteb00f33ab4f409020d47acc2eba17d6bbb69e3be[log] [tgz]
authorLukas Wirth <lukastw97@gmail.com>Mon Sep 02 21:36:34 2024 +0200
committerLukas Wirth <lukastw97@gmail.com>Tue Sep 03 07:51:17 2024 +0200
treef49c2591aa238fc633a09b68e7b959f4adb209be
parent5e7b3c4337693199d21e67346a752d2ef0d3703f [diff]
Various cleanups
3 files changed
tree: f49c2591aa238fc633a09b68e7b959f4adb209be
  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.