Struct PyRegex

pub struct PyRegex { /* private fields */ }

A wrapper for a compiled regular expression from the Python regex library.

Implementations

impl PyRegex

pub fn new(pattern: &str) -> PyResult<Self>

Creates a new regular expression by compiling the pattern via Python’s regex.compile.

Examples found in repository

examples/basic.rs (line 11)

fn main() -> PyResult<()> {
    // Initialize Python for multithreaded usage.
    pyo3::prepare_freethreaded_python();

    let pattern = r"(?P<id>\d+)";
    let text = "IDs: 101, 202, 303";
    let re = Arc::new(PyRegex::new(pattern)?);

    // Example usage of `search_match()` to obtain a `PyRegexMatch` object.
    if let Some(m) = re.search_match(text)? {
        println!("Full match (group 0): {:?}", m.group(0)?);
        println!("Group 'id' (as group 0 here): {:?}", m.group(0)?);
        println!("Groupdict: {:?}", m.groupdict()?);
        println!("Span for group 0: {}..{}", m.start(0)?, m.end(0)?);
    }

    // Example of multithreaded usage of `find_iter()`, returning a `Vec<PyRegexMatch>`.
    let mut handles = vec![];
    for i in 0..4 {
        let re_clone = Arc::clone(&re);
        let text_clone = text.to_string();
        let handle = thread::spawn(move || -> PyResult<()> {
            let matches = re_clone.find_iter(&text_clone)?;
            println!("Thread {}: found {} matches.", i, matches.len());
            for m in matches {
                println!("Thread {}: match group 0: {:?}", i, m.group(0)?);
            }
            Ok(())
        });
        handles.push(handle);
    }

    for handle in handles {
        handle.join().unwrap()?;
    }

    Ok(())
}

pub fn search_match(&self, text: &str) -> PyResult<Option<PyRegexMatch>>

Performs a search for the first match and returns a PyRegexMatch object.

Examples found in repository

examples/basic.rs (line 14)

fn main() -> PyResult<()> {
    // Initialize Python for multithreaded usage.
    pyo3::prepare_freethreaded_python();

    let pattern = r"(?P<id>\d+)";
    let text = "IDs: 101, 202, 303";
    let re = Arc::new(PyRegex::new(pattern)?);

    // Example usage of `search_match()` to obtain a `PyRegexMatch` object.
    if let Some(m) = re.search_match(text)? {
        println!("Full match (group 0): {:?}", m.group(0)?);
        println!("Group 'id' (as group 0 here): {:?}", m.group(0)?);
        println!("Groupdict: {:?}", m.groupdict()?);
        println!("Span for group 0: {}..{}", m.start(0)?, m.end(0)?);
    }

    // Example of multithreaded usage of `find_iter()`, returning a `Vec<PyRegexMatch>`.
    let mut handles = vec![];
    for i in 0..4 {
        let re_clone = Arc::clone(&re);
        let text_clone = text.to_string();
        let handle = thread::spawn(move || -> PyResult<()> {
            let matches = re_clone.find_iter(&text_clone)?;
            println!("Thread {}: found {} matches.", i, matches.len());
            for m in matches {
                println!("Thread {}: match group 0: {:?}", i, m.group(0)?);
            }
            Ok(())
        });
        handles.push(handle);
    }

    for handle in handles {
        handle.join().unwrap()?;
    }

    Ok(())
}

pub fn find_iter(&self, text: &str) -> PyResult<Vec<PyRegexMatch>>

Returns a list of PyRegexMatch objects from finditer().

Examples found in repository

examples/basic.rs (line 27)

fn main() -> PyResult<()> {
    // Initialize Python for multithreaded usage.
    pyo3::prepare_freethreaded_python();

    let pattern = r"(?P<id>\d+)";
    let text = "IDs: 101, 202, 303";
    let re = Arc::new(PyRegex::new(pattern)?);

    // Example usage of `search_match()` to obtain a `PyRegexMatch` object.
    if let Some(m) = re.search_match(text)? {
        println!("Full match (group 0): {:?}", m.group(0)?);
        println!("Group 'id' (as group 0 here): {:?}", m.group(0)?);
        println!("Groupdict: {:?}", m.groupdict()?);
        println!("Span for group 0: {}..{}", m.start(0)?, m.end(0)?);
    }

    // Example of multithreaded usage of `find_iter()`, returning a `Vec<PyRegexMatch>`.
    let mut handles = vec![];
    for i in 0..4 {
        let re_clone = Arc::clone(&re);
        let text_clone = text.to_string();
        let handle = thread::spawn(move || -> PyResult<()> {
            let matches = re_clone.find_iter(&text_clone)?;
            println!("Thread {}: found {} matches.", i, matches.len());
            for m in matches {
                println!("Thread {}: match group 0: {:?}", i, m.group(0)?);
            }
            Ok(())
        });
        handles.push(handle);
    }

    for handle in handles {
        handle.join().unwrap()?;
    }

    Ok(())
}

pub fn is_match(&self, text: &str) -> PyResult<bool>

pub fn find_all(&self, text: &str) -> PyResult<Vec<String>>

pub fn replace(&self, text: &str, replacement: &str) -> PyResult<String>

pub fn split(&self, text: &str) -> PyResult<Vec<String>>

pub fn escape( str: &str, special_only: bool, literal_spaces: bool, ) -> PyResult<String>

Escapes a string.

Trait Implementations

impl Debug for PyRegex

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.