flexstr 0.11.7

A flexible, simple to use, clone-efficient string type for Rust
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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186

#![allow(dead_code)]

use core::fmt;
use flexstr::{FlexStr, RefCounted};
use flexstr_support::StringToFromBytes;
use inline_flexstr::InlineFlexStr;

// Remove Debug requirement from R where not needed

/// Test PartialEq implementation
pub fn test_partial_eq<S, R>(s1: &'static S, s2: &'static S)
where
    S: ?Sized + StringToFromBytes + PartialEq + fmt::Debug,
    R: RefCounted<S> + fmt::Debug,
    Box<S>: From<S::Owned>,
    S::Owned: AsRef<S>,
{
    let flex_str1: FlexStr<'_, S, R> = FlexStr::from_borrowed(s1);
    let flex_str2: FlexStr<'_, S, R> = FlexStr::from_borrowed(s2);

    // Test equality
    if s1 == s2 {
        assert_eq!(flex_str1, flex_str2);
    } else {
        assert!(flex_str1 != flex_str2);
    }

    // Test equality across variants (input should be small enough to inline)
    let inline_str =
        InlineFlexStr::try_from_type(s1).expect("test input should be small enough to inline");
    let inlined: FlexStr<'_, S, R> = FlexStr::from_inline(inline_str);
    assert_eq!(flex_str1, inlined);
}

/// Test Eq implementation
pub fn test_eq<S, R>(s: &'static S)
where
    S: ?Sized + StringToFromBytes + PartialEq + Eq + fmt::Debug,
    R: RefCounted<S> + fmt::Debug,
    Box<S>: From<S::Owned>,
    S::Owned: AsRef<S>,
{
    let flex_str1: FlexStr<'_, S, R> = FlexStr::from_borrowed(s);
    let flex_str2: FlexStr<'_, S, R> = FlexStr::from_borrowed(s);

    // Eq requires reflexivity, symmetry, transitivity
    // Reflexivity: a == a
    assert_eq!(flex_str1, flex_str2); // Symmetry
    assert_eq!(flex_str2, flex_str1); // Symmetry
}

/// Test PartialOrd implementation
pub fn test_partial_ord<S, R>(s1: &'static S, s2: &'static S)
where
    S: ?Sized + StringToFromBytes + PartialOrd,
    R: RefCounted<S>,
{
    let flex_str1: FlexStr<'_, S, R> = FlexStr::from_borrowed(s1);
    let flex_str2: FlexStr<'_, S, R> = FlexStr::from_borrowed(s2);

    // Test inputs should be comparable (partial_cmp should return Some)
    let ord = s1
        .partial_cmp(s2)
        .expect("test inputs should be comparable");
    assert_eq!(flex_str1.partial_cmp(&flex_str2), Some(ord));
}

/// Test Ord implementation
pub fn test_ord<S, R>(s1: &'static S, s2: &'static S)
where
    S: ?Sized + StringToFromBytes + Ord,
    R: RefCounted<S>,
{
    let flex_str1: FlexStr<'_, S, R> = FlexStr::from_borrowed(s1);
    let flex_str2: FlexStr<'_, S, R> = FlexStr::from_borrowed(s2);

    assert_eq!(flex_str1.cmp(&flex_str2), s1.cmp(s2));
}

/// Test Hash implementation consistency
pub fn test_hash<S, R>(s: &'static S)
where
    S: ?Sized + StringToFromBytes + core::hash::Hash,
    R: RefCounted<S>,
    Box<S>: From<S::Owned>,
    S::Owned: AsRef<S>,
{
    use core::hash::{Hash, Hasher};
    use std::collections::hash_map::DefaultHasher;

    // Test that different variants hash to the same value
    let borrowed: FlexStr<'_, S, R> = FlexStr::from_borrowed(s);
    let mut hasher1 = DefaultHasher::new();
    borrowed.hash(&mut hasher1);
    let hash1 = hasher1.finish();

    // Input should be small enough to inline
    let inline_str =
        InlineFlexStr::try_from_type(s).expect("test input should be small enough to inline");
    let inlined: FlexStr<'_, S, R> = FlexStr::from_inline(inline_str);
    let mut hasher2 = DefaultHasher::new();
    inlined.hash(&mut hasher2);
    let hash2 = hasher2.finish();
    assert_eq!(hash1, hash2);

    // Test that ref_counted variant hashes the same
    // Test input should be non-empty
    assert!(
        !s.self_as_bytes().is_empty(),
        "test input should be non-empty"
    );
    let rc: R = s.into();
    let ref_counted: FlexStr<'_, S, R> = FlexStr::from_ref_counted(rc);
    let mut hasher3 = DefaultHasher::new();
    ref_counted.hash(&mut hasher3);
    let hash3 = hasher3.finish();
    assert_eq!(hash1, hash3);
}

/// Test comparison with &S
pub fn test_comparison_with_ref<S, R>(s: &'static S)
where
    S: ?Sized + StringToFromBytes + fmt::Debug + PartialEq,
    R: RefCounted<S>,
{
    let flex_str: FlexStr<'_, S, R> = FlexStr::from_borrowed(s);

    // Test equality with &S - compare through as_ref_type
    assert_eq!(flex_str.as_ref_type(), s);
}

/// Test comparison with S::Owned
pub fn test_comparison_with_owned<S, R>(s: &'static S)
where
    S: ?Sized + StringToFromBytes + fmt::Debug + PartialEq,
    R: RefCounted<S>,
    S::Owned: PartialEq + AsRef<S>,
{
    let flex_str: FlexStr<'_, S, R> = FlexStr::from_borrowed(s);
    let owned = s.to_owned();

    assert_eq!(flex_str.as_ref_type(), owned.as_ref());
}

/// Test comparison with InlineFlexStr
pub fn test_comparison_with_inline<S, R>(s: &'static S)
where
    S: ?Sized + StringToFromBytes + fmt::Debug + PartialEq,
    R: RefCounted<S>,
{
    // Input should be small enough to inline
    let inline_str =
        InlineFlexStr::try_from_type(s).expect("test input should be small enough to inline");
    let flex_str: FlexStr<'_, S, R> = FlexStr::from_borrowed(s);

    assert_eq!(flex_str.as_ref_type(), inline_str.as_ref_type());
}

/// Test PartialEq with owned types (String, Cow, etc.) for FlexStr
pub fn test_partial_eq_with_owned_types<S, R>(s: &'static S)
where
    S: ?Sized + StringToFromBytes + PartialEq + fmt::Debug,
    R: RefCounted<S> + fmt::Debug,
    S::Owned: PartialEq<S> + AsRef<S>,
    Box<S>: From<S::Owned>,
{
    use alloc::borrow::Cow;

    let flex_str: FlexStr<'_, S, R> = FlexStr::from_borrowed(s);
    let owned: S::Owned = s.to_owned();

    // Test FlexStr == S::Owned (through PartialEq implementation)
    assert_eq!(flex_str.as_ref_type(), owned.as_ref());
    // Test reverse comparison: S::Owned == FlexStr
    assert_eq!(owned.as_ref(), flex_str.as_ref_type());

    // Test with Cow::Owned
    let cow_owned: Cow<'_, S> = Cow::Owned(owned);
    assert_eq!(flex_str.as_ref_type(), cow_owned.as_ref());
    assert_eq!(cow_owned.as_ref(), flex_str.as_ref_type());

    // Test with Cow::Borrowed
    let cow_borrowed: Cow<'_, S> = Cow::Borrowed(s);
    assert_eq!(flex_str.as_ref_type(), cow_borrowed.as_ref());
    assert_eq!(cow_borrowed.as_ref(), flex_str.as_ref_type());
}