mut-str 1.0.2

A toolkit for working with mutable string slices (&mut str).
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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303

use core::{slice, str};

use crate::errors::{
    LenNotEqual, ReplaceWithPadCharError, ReplaceWithPadError, ReplacementTooLong,
};

/// Replace the [`prim@str`] with another of the same length.
///
/// ```
/// use mut_str::replace;
///
/// let mut owned_s = Box::<str>::from("World!");
///
/// replace(&mut *owned_s, "🌍!!").unwrap();
/// assert_eq!(&*owned_s, "🌍!!");
///
/// replace(&mut *owned_s, "aaaaaa").unwrap();
/// assert_eq!(&*owned_s, "aaaaaa");
/// ```
///
/// # Errors
/// - If `s` and `r`, when utf8 encoded, do not have the same length, [`LenNotEqual`] will be returned.
pub fn replace<'a>(s: &'a mut str, r: &str) -> Result<&'a mut str, LenNotEqual> {
    if r.len() != s.len() {
        return Err(LenNotEqual);
    }

    // SAFETY:
    // This is valid as it copies one valid string to another of the same
    // length.
    unsafe { s.as_bytes_mut() }.copy_from_slice(r.as_bytes());

    Ok(s)
}

/// Replace the [`prim@str`] with another of the same length or shorter.
/// The remaining bytes will be filled with spaces.
///
/// ```
/// use mut_str::replace_with_pad_space;
///
/// let mut owned_s = Box::<str>::from("World!");
///
/// replace_with_pad_space(&mut *owned_s, "🌍").unwrap();
/// assert_eq!(&*owned_s, "🌍  ");
///
/// replace_with_pad_space(&mut *owned_s, "aaaa").unwrap();
/// assert_eq!(&*owned_s, "aaaa  ");
/// ```
///
/// # Errors
/// - If `r`, when utf8 encoded, is longer than `s`, when utf8 encoded, [`ReplacementTooLong`] will be returned.
pub fn replace_with_pad_space<'a>(
    s: &'a mut str,
    r: &str,
) -> Result<&'a mut str, ReplacementTooLong> {
    if r.len() > s.len() {
        return Err(ReplacementTooLong);
    }

    // SAFETY:
    // This is valid as it copies one valid string to another of at least the
    // same length, replacing the remainder with one byte padding.
    let (slice, remaining) = unsafe { s.as_bytes_mut() }.split_at_mut(r.len());

    slice.copy_from_slice(r.as_bytes());
    remaining.fill(b' ');

    // SAFETY:
    // This is valid as`slice` comes from a `str` split on a char boundary.
    Ok(unsafe { str::from_utf8_unchecked_mut(slice) })
}

/// Replace the [`prim@str`] with another of the same length or shorter.
/// The remaining bytes will be filled with `pad`.
///
/// ```
/// use mut_str::replace_with_pad;
///
/// let mut owned_s = Box::<str>::from("World!");
///
/// replace_with_pad(&mut *owned_s, "🌍", b'!').unwrap();
/// assert_eq!(&*owned_s, "🌍!!");
///
/// replace_with_pad(&mut *owned_s, "aaaa", b'b').unwrap();
/// assert_eq!(&*owned_s, "aaaabb");
/// ```
///
/// # Errors
/// - If `pad` is not valid utf8, [`ReplaceWithPadError::InvalidPad`] will be returned.
/// - If `r`, when utf8 encoded, is longer than `s`, when utf8 encoded, [`ReplaceWithPadError::ReplacementLen`] will be returned.
pub fn replace_with_pad<'a>(
    s: &'a mut str,
    r: &str,
    pad: u8,
) -> Result<&'a mut str, ReplaceWithPadError> {
    if r.len() > s.len() {
        return Err(ReplaceWithPadError::CHAR_LEN);
    }

    str::from_utf8(&[pad])?;

    // SAFETY:
    // This is valid as it copies one valid string to another of at least the
    // same length, replacing the remainder with one byte padding.
    let (slice, remaining) = unsafe { s.as_bytes_mut() }.split_at_mut(r.len());

    slice.copy_from_slice(r.as_bytes());
    remaining.fill(pad);

    // SAFETY:
    // This is valid as`slice` comes from a `str` split on a char boundary.
    Ok(unsafe { str::from_utf8_unchecked_mut(slice) })
}

/// Replace the [`prim@str`] with another of the same length or shorter.
/// The remaining bytes will be filled with `pad`, which must be one byte long.
///
/// ```
/// use mut_str::replace_with_pad_char;
///
/// let mut owned_s = Box::<str>::from("World!");
///
/// replace_with_pad_char(&mut *owned_s, "🌍", '!').unwrap();
/// assert_eq!(&*owned_s, "🌍!!");
///
/// replace_with_pad_char(&mut *owned_s, "aaaa", 'b').unwrap();
/// assert_eq!(&*owned_s, "aaaabb");
/// ```
///
/// # Errors
/// - If `pad_char`, when utf8 encoded, is longer than `Self`, [`ReplaceWithPadCharError::PadCharTooLong`] will be returned.
/// - If `r`, when utf8 encoded, is longer than `s`, when utf8 encoded, [`ReplaceWithPadCharError::ReplacementLen`] will be returned.
pub fn replace_with_pad_char<'a, C>(
    s: &'a mut str,
    r: &str,
    pad_char: C,
) -> Result<&'a mut str, ReplaceWithPadCharError>
where
    C: Into<char>,
{
    let pad_char = pad_char.into();

    if r.len() > s.len() {
        return Err(ReplaceWithPadCharError::CHAR_LEN);
    }

    if pad_char.len_utf8() != 1 {
        return Err(ReplaceWithPadCharError::PadCharTooLong);
    }

    let mut pad: u8 = 0;
    pad_char.encode_utf8(slice::from_mut(&mut pad));

    // SAFETY:
    // This is valid as it copies one valid string to another of at least the
    // same length, replacing the remainder with one byte padding.
    let (slice, remaining) = unsafe { s.as_bytes_mut() }.split_at_mut(r.len());

    slice.copy_from_slice(r.as_bytes());
    remaining.fill(pad);

    // SAFETY:
    // This is valid as`slice` comes from a `str` split on a char boundary.
    Ok(unsafe { str::from_utf8_unchecked_mut(slice) })
}

/// Replace the [`prim@str`] with another of the same length or shorter, right aligned.
/// The remaining bytes before the [`prim@str`] will be filled with spaces.
///
/// ```
/// use mut_str::replace_with_pad_left_space;
///
/// let mut owned_s = Box::<str>::from("World!");
///
/// replace_with_pad_left_space(&mut *owned_s, "🌍").unwrap();
/// assert_eq!(&*owned_s, "  🌍");
///
/// replace_with_pad_left_space(&mut *owned_s, "aaaa").unwrap();
/// assert_eq!(&*owned_s, "  aaaa");
/// ```
///
/// # Errors
/// - If `r`, when utf8 encoded, is longer than `s`, when utf8 encoded, [`ReplacementTooLong`] will be returned.
pub fn replace_with_pad_left_space<'a>(
    s: &'a mut str,
    r: &str,
) -> Result<&'a mut str, ReplacementTooLong> {
    if r.len() > s.len() {
        return Err(ReplacementTooLong);
    }

    let mid = s.len() - r.len();

    // SAFETY:
    // This is valid as it copies one valid string to another of at least the
    // same length, replacing the remainder with one byte padding.
    let (remaining, slice) = unsafe { s.as_bytes_mut() }.split_at_mut(mid);

    slice.copy_from_slice(r.as_bytes());
    remaining.fill(b' ');

    // SAFETY:
    // This is valid as`slice` comes from a `str` split on a char boundary.
    Ok(unsafe { str::from_utf8_unchecked_mut(slice) })
}

/// Replace the [`prim@str`] with another of the same length or shorter, right aligned.
/// The remaining bytes before the character [`prim@str`] will be filled with `pad`.
///
/// ```
/// use mut_str::replace_with_pad_left;
///
/// let mut owned_s = Box::<str>::from("World!");
///
/// replace_with_pad_left(&mut *owned_s, "🌍", b'!').unwrap();
/// assert_eq!(&*owned_s, "!!🌍");
///
/// replace_with_pad_left(&mut *owned_s, "aaaa", b'b').unwrap();
/// assert_eq!(&*owned_s, "bbaaaa");
/// ```
///
/// # Errors
/// - If `pad` is not valid utf8, [`ReplaceWithPadError::InvalidPad`] will be returned.
/// - If `r`, when utf8 encoded, is longer than `s`, when utf8 encoded, [`ReplaceWithPadError::ReplacementLen`] will be returned.
pub fn replace_with_pad_left<'a>(
    s: &'a mut str,
    r: &str,
    pad: u8,
) -> Result<&'a mut str, ReplaceWithPadError> {
    if r.len() > s.len() {
        return Err(ReplaceWithPadError::CHAR_LEN);
    }

    str::from_utf8(&[pad])?;

    let mid = s.len() - r.len();

    // SAFETY:
    // This is valid as it copies one valid string to another of at least the
    // same length, replacing the remainder with one byte padding.
    let (remaining, slice) = unsafe { s.as_bytes_mut() }.split_at_mut(mid);

    slice.copy_from_slice(r.as_bytes());
    remaining.fill(pad);

    // SAFETY:
    // This is valid as`slice` comes from a `str` split on a char boundary.
    Ok(unsafe { str::from_utf8_unchecked_mut(slice) })
}

/// Replace the [`prim@str`] with another of the same length or shorter, right aligned.
/// The remaining bytes before the [`prim@str`] will be filled with `char`, which must be one byte long.
///
/// ```
/// use mut_str::replace_with_pad_left_char;
///
/// let mut owned_s = Box::<str>::from("World!");
///
/// replace_with_pad_left_char(&mut *owned_s, "🌍", '!').unwrap();
/// assert_eq!(&*owned_s, "!!🌍");
///
/// replace_with_pad_left_char(&mut *owned_s, "aaaa", 'b').unwrap();
/// assert_eq!(&*owned_s, "bbaaaa");
/// ```
///
/// # Errors
/// - If `pad_char`, when utf8 encoded, is longer than `Self`, [`ReplaceWithPadCharError::PadCharTooLong`] will be returned.
/// - If `r`, when utf8 encoded, is longer than `s`, when utf8 encoded, [`ReplaceWithPadCharError::ReplacementLen`] will be returned.
pub fn replace_with_pad_left_char<'a, C>(
    s: &'a mut str,
    r: &str,
    pad_char: C,
) -> Result<&'a mut str, ReplaceWithPadCharError>
where
    C: Into<char>,
{
    let pad_char = pad_char.into();
    if r.len() > s.len() {
        return Err(ReplaceWithPadCharError::CHAR_LEN);
    }

    if pad_char.len_utf8() != 1 {
        return Err(ReplaceWithPadCharError::PadCharTooLong);
    }

    let mut pad: u8 = 0;
    pad_char.encode_utf8(slice::from_mut(&mut pad));

    let mid = s.len() - r.len();

    // SAFETY:
    // This is valid as it copies one valid string to another of at least the
    // same length, replacing the remainder with one byte padding.
    let (remaining, slice) = unsafe { s.as_bytes_mut() }.split_at_mut(mid);

    slice.copy_from_slice(r.as_bytes());
    remaining.fill(pad);

    // SAFETY:
    // This is valid as`slice` comes from a `str` split on a char boundary.
    Ok(unsafe { str::from_utf8_unchecked_mut(slice) })
}