light_clone 0.4.1

Compile-time enforcement for O(1) clone operations
Documentation 
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

use std::sync::Arc;

/// An immutable, cheaply-cloneable string.
///
/// `LightStr` is a type alias for `Arc<str>`, providing a string type that is O(1) to clone.
/// Unlike `String`, cloning a `LightStr` only bumps a reference count—it never allocates
/// or copies string data.
///
/// # Examples
///
/// ```
/// use light_clone::{LightStr, IntoLightStr};
///
/// // Create from a string literal
/// let name: LightStr = "Alice".into_light_str();
///
/// // Clone is O(1) - just bumps refcount
/// let name_copy = name.clone();
/// assert_eq!(name, name_copy);
/// ```
///
/// # Underlying Type
///
/// `LightStr` is defined as `Arc<str>`. You can use either type interchangeably:
///
/// ```
/// use std::sync::Arc;
/// use light_clone::LightStr;
///
/// fn accepts_arc_str(s: &Arc<str>) {}
///
/// let name: LightStr = Arc::from("Bob");
/// accepts_arc_str(&name);
/// ```
pub type LightStr = Arc<str>;