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

#24 in Rust patterns

Download history 297873/week @ 2024-11-20 298617/week @ 2024-11-27 328445/week @ 2024-12-04 315720/week @ 2024-12-11 263471/week @ 2024-12-18 184047/week @ 2024-12-25 253510/week @ 2025-01-01 345547/week @ 2025-01-08 348605/week @ 2025-01-15 330758/week @ 2025-01-22 354990/week @ 2025-01-29 409156/week @ 2025-02-05 498672/week @ 2025-02-12 566305/week @ 2025-02-19 585833/week @ 2025-02-26 585663/week @ 2025-03-05

2,322,618 downloads per month
Used in 2,921 crates (254 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

~225KB