[ISSUE #15]Add doc

mxsm · Nov 7, 2024 · 4063000 · 4063000
1 parent 2105eab
commit 4063000
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/src/cheetah_string.rs b/src/cheetah_string.rs
@@ -172,6 +172,14 @@ impl CheetahString {
     }
 }
 
+/// The `InnerString` enum represents different types of string storage.
+///
+/// Variants:
+///
+/// * `ArcString(Arc<String>)` - A reference-counted string.
+/// * `StaticStr(&'static str)` - A static string slice.
+/// * `Bytes(bytes::Bytes)` - A byte buffer (available when the "bytes" feature is enabled).
+/// * `Empty` - An empty string.
 #[derive(Clone)]
 pub(super) enum InnerString {
     ArcString(Arc<String>),