cow_replace/

lib.rs

use std::borrow::Cow;

use ascii::AsciiChar;

// Helper functions for common operations
fn remove_ascii_from_str(s: &str, ch: AsciiChar) -> Option<String> {
    let target_byte = ch.as_byte();
    let bytes = s.as_bytes();

    // Check if the character exists first
    if !bytes.contains(&target_byte) {
        return None;
    }

    // Create new string without the target character
    let mut result = String::with_capacity(s.len());
    for &byte in bytes {
        if byte != target_byte {
            result.push(byte as char);
        }
    }

    Some(result)
}

fn replace_str_if_contains(s: &str, from: &str, to: &str) -> Option<String> {
    if from.is_empty() || !s.contains(from) {
        return None;
    }

    Some(s.replace(from, to))
}

/// Trait for string replacement operations that return a `Cow<str>`.
///
/// This trait provides methods for string manipulations that avoid unnecessary
/// allocations when no changes are needed, returning `Cow::Borrowed` for
/// unchanged strings and `Cow::Owned` for modified strings.
pub trait ReplaceString {
    /// Removes all occurrences of the specified ASCII character from the
    /// string.
    ///
    /// # Arguments
    ///
    /// * `ch` - The ASCII character to remove from the string
    ///
    /// # Returns
    ///
    /// * `Cow::Borrowed` - If the character is not found in the string (no
    ///   allocation needed)
    /// * `Cow::Owned` - If the character is found and removed (new string
    ///   allocated)
    ///
    /// # Examples
    ///
    /// ```
    /// use cow_replace::ReplaceString;
    /// use ascii::AsciiChar;
    /// use std::borrow::Cow;
    ///
    /// let text = "hello world";
    /// let result = text.remove_all_ascii(AsciiChar::l);
    /// assert_eq!(result, "heo word");
    ///
    /// // No allocation when character not found
    /// let result = text.remove_all_ascii(AsciiChar::z);
    /// match result {
    ///     Cow::Borrowed(_) => println!("No allocation needed!"),
    ///     Cow::Owned(_) => unreachable!(),
    /// }
    /// ```
    fn remove_all_ascii(&self, ch: AsciiChar) -> Cow<'_, str>;

    /// Replaces all occurrences of a substring with another substring.
    ///
    /// # Arguments
    ///
    /// * `from` - The substring to search for and replace
    /// * `to` - The replacement substring
    ///
    /// # Returns
    ///
    /// * `Cow::Borrowed` - If `from` is not found in the string (no allocation
    ///   needed)
    /// * `Cow::Owned` - If replacements were made (new string allocated)
    ///
    /// # Examples
    ///
    /// ```
    /// use cow_replace::ReplaceString;
    /// use std::borrow::Cow;
    ///
    /// let text = "hello world hello";
    /// let result = text.replace_all_str("hello", "hi");
    /// assert_eq!(result, "hi world hi");
    ///
    /// // No allocation when substring not found
    /// let result = text.replace_all_str("xyz", "abc");
    /// match result {
    ///     Cow::Borrowed(_) => println!("No allocation needed!"),
    ///     Cow::Owned(_) => unreachable!(),
    /// }
    /// ```
    fn replace_all_str(&self, from: &str, to: &str) -> Cow<'_, str>;
}

/// Trait for in-place string replacement operations.
///
/// This trait provides methods that modify the string directly without creating
/// new allocations when possible. These operations are more memory-efficient
/// but modify the original string.
pub trait ReplaceStringInPlace {
    /// Removes all occurrences of the specified ASCII character from the string
    /// in-place.
    ///
    /// This method modifies the string directly, potentially reducing its
    /// length. For `Cow<str>`, this may convert a borrowed string to an
    /// owned string if modifications are needed.
    ///
    /// # Arguments
    ///
    /// * `ch` - The ASCII character to remove from the string
    ///
    /// # Examples
    ///
    /// ```
    /// use cow_replace::ReplaceStringInPlace;
    /// use ascii::AsciiChar;
    ///
    /// let mut text = "hello world".to_string();
    /// text.remove_all_ascii_in_place(AsciiChar::l);
    /// assert_eq!(text, "heo word");
    ///
    /// // Works with empty results too
    /// let mut text = "lllll".to_string();
    /// text.remove_all_ascii_in_place(AsciiChar::l);
    /// assert_eq!(text, "");
    /// ```
    fn remove_all_ascii_in_place(&mut self, ch: AsciiChar);

    /// Replaces all occurrences of one ASCII character with another in-place.
    ///
    /// This method modifies the string directly by replacing bytes. Since both
    /// characters are ASCII, the string length remains the same.
    ///
    /// # Arguments
    ///
    /// * `from` - The ASCII character to search for and replace
    /// * `to` - The ASCII character to replace with
    ///
    /// # Examples
    ///
    /// ```
    /// use cow_replace::ReplaceStringInPlace;
    /// use ascii::AsciiChar;
    ///
    /// let mut text = "hello world".to_string();
    /// text.replace_all_ascii_in_place(AsciiChar::l, AsciiChar::x);
    /// assert_eq!(text, "hexxo worxd");
    ///
    /// // No change if character not found
    /// let mut text = "hello world".to_string();
    /// text.replace_all_ascii_in_place(AsciiChar::z, AsciiChar::x);
    /// assert_eq!(text, "hello world");
    /// ```
    fn replace_all_ascii_in_place(&mut self, from: AsciiChar, to: AsciiChar);
}

impl<T: AsRef<str>> ReplaceString for T {
    fn remove_all_ascii(&self, ch: AsciiChar) -> Cow<'_, str> {
        match remove_ascii_from_str(self.as_ref(), ch) {
            Some(result) => Cow::Owned(result),
            None => Cow::Borrowed(self.as_ref()),
        }
    }

    fn replace_all_str(&self, from: &str, to: &str) -> Cow<'_, str> {
        match replace_str_if_contains(self.as_ref(), from, to) {
            Some(result) => Cow::Owned(result),
            None => Cow::Borrowed(self.as_ref()),
        }
    }
}
impl ReplaceStringInPlace for String {
    fn remove_all_ascii_in_place(&mut self, ch: AsciiChar) {
        let target_byte = ch.as_byte();
        let bytes = unsafe { self.as_bytes_mut() };

        let mut write_pos = 0;
        let mut read_pos = 0;

        while read_pos < bytes.len() {
            if bytes[read_pos] != target_byte {
                bytes[write_pos] = bytes[read_pos];
                write_pos += 1;
            }
            read_pos += 1;
        }

        // Truncate to the new length
        self.truncate(write_pos);
    }

    fn replace_all_ascii_in_place(&mut self, from: AsciiChar, to: AsciiChar) {
        let from_byte = from.as_byte();
        let to_byte = to.as_byte();
        let bytes = unsafe { self.as_bytes_mut() };

        for byte in bytes {
            if *byte == from_byte {
                *byte = to_byte;
            }
        }
    }
}

impl ReplaceStringInPlace for Cow<'_, str> {
    fn remove_all_ascii_in_place(&mut self, ch: AsciiChar) {
        match self {
            Cow::Borrowed(s) => {
                if let Some(result) = remove_ascii_from_str(s, ch) {
                    *self = Cow::Owned(result);
                }
            }
            Cow::Owned(s) => {
                s.remove_all_ascii_in_place(ch);
            }
        }
    }

    fn replace_all_ascii_in_place(&mut self, from: AsciiChar, to: AsciiChar) {
        match self {
            Cow::Borrowed(s) => {
                let from_byte = from.as_byte();
                let bytes = s.as_bytes();

                if !bytes.contains(&from_byte) {
                    return; // No changes needed
                }

                // Convert to owned and replace
                let mut owned = s.to_string();
                owned.replace_all_ascii_in_place(from, to);
                *self = Cow::Owned(owned);
            }
            Cow::Owned(s) => {
                s.replace_all_ascii_in_place(from, to);
            }
        }
    }
}

#[cfg(test)]
mod tests {
    use std::borrow::Cow;

    use super::*;

    #[test]
    fn test_str_remove_all_ascii() {
        let s = "hello world";
        let result = s.remove_all_ascii(AsciiChar::l);
        assert_eq!(result, "heo word");

        // Test with no occurrences
        let s = "hello world";
        let result = s.remove_all_ascii(AsciiChar::z);
        assert_eq!(result, "hello world");
        match result {
            Cow::Borrowed(_) => {}
            Cow::Owned(_) => panic!("Should return borrowed when no changes"),
        }
    }

    #[test]
    fn test_str_replace_all_str() {
        let s = "hello world hello";
        let result = s.replace_all_str("hello", "hi");
        assert_eq!(result, "hi world hi");

        // Test with no occurrences
        let s = "hello world";
        let result = s.replace_all_str("xyz", "abc");
        match result {
            Cow::Borrowed(_) => {}
            Cow::Owned(_) => panic!("Should return borrowed when no changes"),
        }
        assert_eq!(result, "hello world");
    }

    #[test]
    fn test_string_remove_all_ascii() {
        let s = "hello world".to_string();
        let result = s.remove_all_ascii(AsciiChar::l);
        assert_eq!(result, "heo word");

        // Test with no occurrences
        let s = "hello world".to_string();
        let result = s.remove_all_ascii(AsciiChar::z);
        assert_eq!(result, "hello world");
        match result {
            Cow::Borrowed(_) => {}
            Cow::Owned(_) => panic!("Should return borrowed when no changes"),
        }
    }

    #[test]
    fn test_string_remove_all_ascii_in_place() {
        let mut s = "hello world".to_string();
        s.remove_all_ascii_in_place(AsciiChar::l);
        assert_eq!(s, "heo word");

        let mut s = "aaaaaa".to_string();
        s.remove_all_ascii_in_place(AsciiChar::a);
        assert_eq!(s, "");
    }

    #[test]
    fn test_string_replace_all_ascii_in_place() {
        let mut s = "hello world".to_string();
        s.replace_all_ascii_in_place(AsciiChar::l, AsciiChar::x);
        assert_eq!(s, "hexxo worxd");

        let mut s = "hello world".to_string();
        s.replace_all_ascii_in_place(AsciiChar::z, AsciiChar::x);
        assert_eq!(s, "hello world");
    }

    #[test]
    fn test_string_replace_all_str() {
        let s = "hello world hello".to_string();
        let result = s.replace_all_str("hello", "hi");
        assert_eq!(result, "hi world hi");
        assert_eq!(s, "hello world hello"); // Original string should remain unchanged

        // Test with no occurrences
        let s = "hello world".to_string();
        let result = s.replace_all_str("xyz", "abc");
        match result {
            Cow::Borrowed(_) => {}
            Cow::Owned(_) => panic!("Should return borrowed when no changes"),
        }
        assert_eq!(result, "hello world");
        assert_eq!(s, "hello world");
    }

    #[test]
    fn test_cow_remove_all_ascii() {
        let s: Cow<'_, str> = Cow::Borrowed("hello world");
        let result = s.remove_all_ascii(AsciiChar::l);
        assert_eq!(result, "heo word");

        let s: Cow<'_, str> = Cow::Owned("hello world".to_string());
        let result = s.remove_all_ascii(AsciiChar::l);
        assert_eq!(result, "heo word");
    }

    #[test]
    fn test_cow_remove_all_ascii_in_place() {
        let mut s: Cow<'_, str> = Cow::Borrowed("hello world");
        s.remove_all_ascii_in_place(AsciiChar::l);
        assert_eq!(s, "heo word");
        match s {
            Cow::Owned(_) => {}
            Cow::Borrowed(_) => panic!("Should be owned after modification"),
        }

        let mut s: Cow<'_, str> = Cow::Owned("hello world".to_string());
        s.remove_all_ascii_in_place(AsciiChar::l);
        assert_eq!(s, "heo word");
    }

    #[test]
    fn test_cow_replace_all_ascii_in_place() {
        let mut s: Cow<'_, str> = Cow::Borrowed("hello world");
        s.replace_all_ascii_in_place(AsciiChar::l, AsciiChar::x);
        assert_eq!(s, "hexxo worxd");
        match s {
            Cow::Owned(_) => {}
            Cow::Borrowed(_) => panic!("Should be owned after modification"),
        }
    }

    #[test]
    fn test_cow_replace_all_str() {
        let s: Cow<'_, str> = Cow::Borrowed("hello world hello");
        let result = s.replace_all_str("hello", "hi");
        assert_eq!(result, "hi world hi");
        assert_eq!(s, "hello world hello"); // Original string should remain unchanged

        let s: Cow<'_, str> = Cow::Borrowed("hello world");
        let result = s.replace_all_str("xyz", "abc");
        match result {
            Cow::Borrowed(_) => {}
            Cow::Owned(_) => panic!("Should return borrowed when no changes"),
        }
        assert_eq!(result, "hello world");
        assert_eq!(s, "hello world");
    }

    #[test]
    fn test_trait_separation() {
        // Test that we can use both traits separately
        fn use_replace_string<T: ReplaceString>(s: &T) -> Cow<'_, str> {
            s.remove_all_ascii(AsciiChar::l)
        }

        fn use_replace_string_in_place<T: ReplaceStringInPlace>(s: &mut T) {
            s.remove_all_ascii_in_place(AsciiChar::l);
        }

        let s1 = "hello world";
        let result = use_replace_string(&s1);
        assert_eq!(result, "heo word");

        let s2 = "hello world".to_string();
        let result = use_replace_string(&s2);
        assert_eq!(result, "heo word");

        let mut s3 = "hello world".to_string();
        use_replace_string_in_place(&mut s3);
        assert_eq!(s3, "heo word");

        let mut s4: Cow<'_, str> = Cow::Borrowed("hello world");
        use_replace_string_in_place(&mut s4);
        assert_eq!(s4, "heo word");
    }
}