26 releases

0.2.1 Jan 16, 2024
0.2.0 Apr 11, 2023
0.1.25 Mar 30, 2023
0.1.23 Apr 26, 2022
0.1.7 Oct 13, 2018

#28 in Rust patterns

Download history 88899/week @ 2023-12-23 119894/week @ 2023-12-30 158861/week @ 2024-01-06 181806/week @ 2024-01-13 189315/week @ 2024-01-20 193462/week @ 2024-01-27 199831/week @ 2024-02-03 204630/week @ 2024-02-10 204836/week @ 2024-02-17 186710/week @ 2024-02-24 195107/week @ 2024-03-02 190661/week @ 2024-03-09 199197/week @ 2024-03-16 199481/week @ 2024-03-23 202310/week @ 2024-03-30 162228/week @ 2024-04-06

793,609 downloads per month
Used in 1,612 crates (154 directly)

MIT/Apache

27KB
696 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

~200KB