1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
//! FastStr: A flexible, easy-to-use, immutable, efficient `String` replacement for Rust.
//!
//! ## What is FastStr
//! [FastStr] is a read-only string wrapper. You can think of it as an ownership `&str` type.
//! FastStr uses three variants of `&'static str`, `Arc<String>` and `StackString`, and automatically selects the best storage method;
//! And optimized string cloning and string comparison.
//!
//! ## What Is It For?
//! [FastStr] is better than String as long as it is not often necessary to modify strings and connect strings.
//!
//! ## How To Use It?
//! String constants are easily wrapped into the unified [FastStr] type. For other string types, different types of storage will be automatically selected.
//! ```
//! use fast_str::FastStr;
//! // compile-time constants
//! const EMPTY_STR: FastStr = FastStr::new();
//! const STATIC_STR: FastStr = FastStr::from_static("💙❤");
//!
//! let str1: FastStr = "🍷 wink".into();
//! // String storage is used in 32-bit machines,
//! // and stack memory is used in 64 bit machines to store strings
//! let str2 = FastStr::from_ref("😆 Happy");
//!
//! // You can use the operator '+' to connect strings.
//! let str3: FastStr = str1 + str2;
//!
//! // O(1) Clone() of time complexity.
//! let str4: FastStr = str3.clone();
//!
//! // You can use String as the storage variant of FastStr,
//! // and when FastStr has the sole ownership of the String variant,
//! // no performance consumption is converted to the String type.
//! let from_string = FastStr::from_string(String::from("hello world"));
//! let from_faststr = String::from(from_string);
//! ```
//!
//! ## Feature Flags
//!
//! `fast-str` comes with optional support for the following crates through Cargo
//! feature flags. You can enable them in your `Cargo.toml` file like this:
//!
//! ```no_compile
//! [dependencies]
//! fast-str = { version = "*", features = ["rocket", "serde"] }
//! ```
//!
//! | Feature | Description |
//! | ------- | ----------- |
//! | [`arbitrary`](https://crates.io/crates/arbitrary) | [`Arbitrary`](https://docs.rs/arbitrary/latest/arbitrary/trait.Arbitrary.html) implementation for [`FastStr`]. |
//! | [`actix-web`](https://crates.io/crates/actix-web) | [`Responder`](https://docs.rs/actix-web/latest/actix_web/trait.Responder.html) implementation for [`FastStr`]. |
//! | [`serde`](https://crates.io/crates/serde) | [`Serialize`](https://docs.rs/arbitrary/latest/arbitrary/trait.Arbitrary.html) and [`Deserialize`](https://docs.rs/serde/latest/serde/trait.Deserialize.html) implementations for [`FastStr`]. |
//! | [`diffus`](https://crates.io/crates/diffus) | [`Same`](https://docs.rs/diffus/0.10.0/diffus/trait.Same.html) and [`Deserialize`](https://docs.rs/diffus/0.10.0/diffus/trait.Diffable.html) implementations for [`FastStr`]. |
pub use FastStr;