Struct PyRegexMatch

pub struct PyRegexMatch { /* private fields */ }

A wrapper for the match object from the Python regex module.

Implementations

impl PyRegexMatch

pub fn group(&self, group: u16) -> PyResult<Option<String>>

Returns the match for the specified group. For example, group(0) is the entire match, group(1) is the first subgroup, etc.

Examples found in repository

examples/basic.rs (line 15)

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 groups(&self) -> PyResult<Vec<Option<String>>>

Returns all captured groups as a vector. Analogous to Python’s groups() method, which returns a tuple of all subgroups (starting from 1).

pub fn groupdict(&self) -> PyResult<HashMap<String, Option<String>>>

Returns the named groups dictionary (groupdict()) as a HashMap.

Examples found in repository

examples/basic.rs (line 17)

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 start(&self, group: u16) -> PyResult<isize>

Returns the start position of the match for the specified group.

Examples found in repository

examples/basic.rs (line 18)

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 end(&self, group: u16) -> PyResult<isize>

Returns the end position of the match for the specified group.

Examples found in repository

examples/basic.rs (line 18)

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(())
}