28 releases

0.3.2 Oct 23, 2024
0.2.2 May 14, 2024
0.2.1 Jan 16, 2024
0.2.0 Apr 11, 2023
0.1.7 Oct 13, 2018

#25 in Rust patterns

Download history 271378/week @ 2024-10-28 294501/week @ 2024-11-04 285645/week @ 2024-11-11 295617/week @ 2024-11-18 290093/week @ 2024-11-25 323865/week @ 2024-12-02 328600/week @ 2024-12-09 305954/week @ 2024-12-16 183335/week @ 2024-12-23 213909/week @ 2024-12-30 321989/week @ 2025-01-06 368786/week @ 2025-01-13 321905/week @ 2025-01-20 344872/week @ 2025-01-27 389083/week @ 2025-02-03 494770/week @ 2025-02-10

1,581,222 downloads per month
Used in 2,829 crates (248 directly)

MIT/Apache

36KB
855 lines

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.

Dependencies

~220KB