Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.
ArrayString
String based on generic array
Since rust doesn't have constant generics yet typenum
is used to allow for generic arrays (U1 to U255)
If you need bigger than U255
open an issue explaining your use-case and we may implement
Can't outgrow initial capacity (defined at compile time), always occupies capacity
+ 1
bytes of memory
Doesn't allocate memory on the heap and never panics in release (all panic branches are stripped at compile time - except Index
/IndexMut
traits, since they are supposed to)
Why
Data is generally bounded, you don't want a phone number with 30 characters, nor a username with 100. You probably don't even support it in your database.
Why pay the cost of heap allocations of strings with unlimited capacity if you have limited boundaries?
Stack based strings are generally faster to create, clone and append to than heap based strings (custom allocators and thread-locals may help with heap based ones).
But that becomes less true as you increase the array size, CacheString
occuppies a full cache line, 255 bytes is the maximum we accept - MaxString
(bigger will just wrap) and it's probably already slower than heap based strings of that size (like in std::string::String
)
There are other stack based strings out there, they generally can have "unlimited" capacity (heap allocate), but the stack based size is defined by the library implementor, we go through a different route by implementing a string based in a generic array.
Array based strings always occupies the full space in memory, so they may use more memory (in the stack) than dynamic strings.
TODO: bench against other implementations
Features
default: std
-
std
enabled by default, enablesstd
compatibility -impl Error
trait for errors (remove it to be#[no_std]
compatible) -
serde-traits
enables serde traits integration (Serialize
/Deserialize
)Opperates like
String
, but truncates it if it's bigger than capacity -
diesel-traits
enables diesel traits integration (Insertable
/Queryable
)Opperates like
String
, but truncates it if it's bigger than capacity -
logs
enables internal loggingYou will probably only need this if you are debugging this library
Examples
use ;
type Username = ;
type Role = ;
Licenses
MIT and Apache-2.0