diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-17 12:02:58 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-17 12:02:58 +0000 |
commit | 698f8c2f01ea549d77d7dc3338a12e04c11057b9 (patch) | |
tree | 173a775858bd501c378080a10dca74132f05bc50 /vendor/tinystr/README.md | |
parent | Initial commit. (diff) | |
download | rustc-698f8c2f01ea549d77d7dc3338a12e04c11057b9.tar.xz rustc-698f8c2f01ea549d77d7dc3338a12e04c11057b9.zip |
Adding upstream version 1.64.0+dfsg1.upstream/1.64.0+dfsg1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'vendor/tinystr/README.md')
-rw-r--r-- | vendor/tinystr/README.md | 95 |
1 files changed, 95 insertions, 0 deletions
diff --git a/vendor/tinystr/README.md b/vendor/tinystr/README.md new file mode 100644 index 000000000..15a8338be --- /dev/null +++ b/vendor/tinystr/README.md @@ -0,0 +1,95 @@ +# tinystr [![crates.io](http://meritbadge.herokuapp.com/tinystr)](https://crates.io/crates/tinystr) [![Build Status](https://travis-ci.org/zbraniecki/tinystr.svg?branch=master)](https://travis-ci.org/zbraniecki/tinystr) [![Coverage Status](https://coveralls.io/repos/github/zbraniecki/tinystr/badge.svg?branch=master)](https://coveralls.io/github/zbraniecki/tinystr?branch=master) + +`tinystr` is a small ASCII-only bounded length string representation. + +Usage +----- + +```rust +use tinystr::{TinyStr4, TinyStr8, TinyStr16, TinyStrAuto}; + +fn main() { + let s1: TinyStr4 = "tEsT".parse() + .expect("Failed to parse."); + + assert_eq!(s1, "tEsT"); + assert_eq!(s1.to_ascii_uppercase(), "TEST"); + assert_eq!(s1.to_ascii_lowercase(), "test"); + assert_eq!(s1.to_ascii_titlecase(), "Test"); + assert_eq!(s1.is_ascii_alphanumeric(), true); + + let s2: TinyStr8 = "New York".parse() + .expect("Failed to parse."); + + assert_eq!(s2, "New York"); + assert_eq!(s2.to_ascii_uppercase(), "NEW YORK"); + assert_eq!(s2.to_ascii_lowercase(), "new york"); + assert_eq!(s2.to_ascii_titlecase(), "New york"); + assert_eq!(s2.is_ascii_alphanumeric(), false); + + let s3: TinyStr16 = "metaMoRphosis123".parse() + .expect("Failed to parse."); + + assert_eq!(s3, "metaMoRphosis123"); + assert_eq!(s3.to_ascii_uppercase(), "METAMORPHOSIS123"); + assert_eq!(s3.to_ascii_lowercase(), "metamorphosis123"); + assert_eq!(s3.to_ascii_titlecase(), "Metamorphosis123"); + assert_eq!(s3.is_ascii_alphanumeric(), true); + + let s4: TinyStrAuto = "shortNoAlloc".parse().unwrap(); + assert!(matches!(s4, TinyStrAuto::Tiny { .. })); + assert_eq!(s4, "shortNoAlloc"); + + let s5: TinyStrAuto = "longFallbackToHeap".parse().unwrap(); + assert!(matches!(s4, TinyStrAuto::Heap { .. })); + assert_eq!(s4, "shortNoAlloc"); +} +``` + +Details +------- + +The crate provides three structs and an enum: + * `TinyStr4` an ASCII-only string limited to 4 characters. + * `TinyStr8` an ASCII-only string limited to 8 characters. + * `TinyStr16` an ASCII-only string limited to 16 characters. + * `TinyStrAuto` (enum): + * `Tiny` when the string is 16 characters or less. + * `Heap` when the string is 17 or more characters. + +The structs stores the characters as `u32`/`u64`/`u128` and uses bitmasking to provide basic string manipulation operations: + * is_ascii_numeric + * is_ascii_alphabetic + * is_ascii_alphanumeric + * to_ascii_lowercase + * to_ascii_uppercase + * to_ascii_titlecase + * PartialEq + +`TinyStrAuto` stores the string as a TinyStr16 when it is short enough, or else falls back to a standard `String`. You should use TinyStrAuto when you expect most strings to be 16 characters or smaller, but occasionally you receive one that exceeds that length. Unlike the structs, `TinyStrAuto` does not implement `Copy`. + +This set is sufficient for certain classes of uses such as `unic-langid` libraries. + +no_std +------ + +Disable the `std` feature of this crate to make it `#[no_std]`. Doing so disables `TinyStrAuto`. You +can re-enable `TinyStrAuto` in `#[no_std]` mode by enabling the `alloc` feature. + +Performance +----------- + +For those uses, TinyStr provides [performance characteristics](https://github.com/zbraniecki/tinystr/wiki/Performance) much better than the regular `String`. + +Status +------ + +The crate is fully functional and ready to be used in production. +The capabilities can be extended. + +#### License + +<sup> +Licensed under either of <a href="LICENSE-APACHE">Apache License, Version +2.0</a> or <a href="LICENSE-MIT">MIT license</a> at your option. +</sup |