string-patterns 0.4.0

Makes it easier to work with common string patterns and regular expressions in Rust, adding convenient regex match and replace methods (pattern_match and pattern_replace) to the standard String type as well to vectors of strings
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

use regex::Error;
use crate::pattern_cache::with_cached_regex;
use std::borrow::ToOwned;

/// Core regular expression replacement methods 
pub trait PatternReplace where Self:Sized {

  /// Replace all matches of the pattern within a longer text with a boolean case_insensitive flag
  /// NB: If the regex doesn't compile it will return an Error, otherwise in Ok result.
  /// If the regex fails, nothing will be replaced
  fn pattern_replace_result(&self, pattern: &str, replacement: &str,case_insensitive: bool) -> Result<Self, Error> where Self:Sized;

  /// Replace only the first match of the pattern within a longer text with a boolean case_insensitive flag
  /// NB: If the regex doesn't compile it will return an Error, otherwise in Ok result.
  /// If the regex fails, nothing will be replaced
  fn pattern_replace_first_result(&self, pattern: &str, replacement: &str,case_insensitive: bool) -> Result<Self, Error> where Self:Sized;

  /// Replace all matches of the pattern within a longer text with a boolean case_insensitive flag
  /// Returns a copy of the same data type. If the regex fails, nothing will be replaced.
  fn pattern_replace(&self, pattern: &str, replacement: &str, case_insensitive: bool) -> Self where Self:Sized;


  /// Replace only the first match of the pattern within a longer text with a boolean case_insensitive flag
  /// Returns a copy of the same data type. If the regex fails, nothing will be replaced.
  fn pattern_replace_first(&self, pattern: &str, replacement: &str, case_insensitive: bool) -> Self where Self:Sized;


  /// Replace all matches of the pattern within a longer text in case-insensitive mode
  /// If the regex fails, nothing will be replaced
  fn pattern_replace_ci(&self, pattern: &str, replacement: &str) -> Self where Self:Sized {
    self.pattern_replace(pattern, replacement, true)
  }

  /// Replace all matches of the pattern within a longer text in case-sensitive mode
  /// If the regex fails, nothing will be replaced
  fn pattern_replace_cs(&self, pattern: &str, replacement: &str) -> Self where Self:Sized {
    self.pattern_replace(pattern, replacement, false)
  }

  /// Replace the first match only of the pattern within a longer text in case-insensitive mode
  /// If the regex fails, nothing will be replaced
  fn pattern_replace_first_ci(&self, pattern: &str, replacement: &str) -> Self where Self:Sized {
    self.pattern_replace_first(pattern, replacement, true)
  }

  /// Replace the first match only of the pattern within a longer text in case-sensitive mode
  /// If the regex fails, nothing will be replaced
  fn pattern_replace_first_cs(&self, pattern: &str, replacement: &str) -> Self where Self:Sized {
    self.pattern_replace_first(pattern, replacement, false)
  }

}

/// Core regex replacement methods for Strings
impl PatternReplace for String {

  /// Regex-enabled replace method that will return an OK String result if successful and an error if the regex fails
  fn pattern_replace_result(&self, pattern: &str, replacement: &str, case_insensitive: bool) -> Result<String, Error> {
    with_cached_regex(pattern, case_insensitive, |re| re.replace_all(self, replacement).to_string())
  }

  /// Regex-enabled replace method that will return an OK String result if successful and an error if the regex fails
  fn pattern_replace_first_result(&self, pattern: &str, replacement: &str, case_insensitive: bool) -> Result<String, Error> {
    with_cached_regex(pattern, case_insensitive, |re| re.replace(self, replacement).to_string())
  }

  /// Simple regex-enabled replace-all method that will return the same string if the regex fails
  fn pattern_replace(&self, pattern: &str, replacement: &str, case_insensitive: bool) -> String {
    self.pattern_replace_result(pattern, replacement, case_insensitive).unwrap_or(self.to_owned())
  }

  /// Regex-enabled single replace method that will return an OK String result if successful and an error if the regex fails
  fn pattern_replace_first(&self, pattern: &str, replacement: &str, case_insensitive: bool) -> String {
    self.pattern_replace_first_result(pattern, replacement, case_insensitive).unwrap_or(self.to_owned())
  }

}

/// Implemented separately of arrays / vectors of strings to ensure the regex is only compiled once
impl PatternReplace for Vec<String> {
  ///
  /// Optional regex-enabled replace method that will return None if the regex fails
  /// 
  fn pattern_replace_result(&self, pattern: &str, replacement: &str, case_insensitive: bool) -> Result<Vec<String>, Error> {
    with_cached_regex(pattern, case_insensitive, |re| {
      self.into_iter()
          .map(|segment| re.replace_all(segment, replacement).to_string())
          .collect::<Vec<String>>()
    })
  }

  ///
  /// Optional regex-enabled replace method that will return None if the regex fails
  ///
  fn pattern_replace_first_result(&self, pattern: &str, replacement: &str, case_insensitive: bool) -> Result<Vec<String>, Error> {
    with_cached_regex(pattern, case_insensitive, |re| {
      self.into_iter()
          .map(|segment| re.replace(segment, replacement).to_string())
          .collect::<Vec<String>>()
    })
  }

  /// Simple regex-enabled replace-all method that will return the same string if the regex fails
  fn pattern_replace(&self, pattern: &str, replacement: &str, case_insensitive: bool) -> Vec<String> {
    self.pattern_replace_result(pattern, replacement, case_insensitive).unwrap_or(self.to_owned())
  }

  /// Simple regex-enabled replace-first method that will return the same string if the regex fails
  fn pattern_replace_first(&self, pattern: &str, replacement: &str, case_insensitive: bool) -> Vec<String> {
    self.pattern_replace_first_result(pattern, replacement, case_insensitive).unwrap_or(self.to_owned())
  }

}