Struct std::regex::Captures

Capture groups from a regex match

Contains the matched text and positions of capture groups

Methods

• fn get_match(self: &Captures) -> Option<&[u8]>

  source

  Get the full matched text (capture group 0)

  Example

  use std::regex::Regex;
  
  let re = Regex::compile("\\d+").unwrap();
  defer re.free();
  let caps = re.captures("foo 123 bar").unwrap();
  defer caps.free();
  assert_eq!(caps.get_match().unwrap(), "123");
  Run this example

• fn get(self: &Captures, group: usize) -> Option<&[u8]>

  source

  Get a capture group by index (0 = full match, 1+ = user groups)

  Example

  use std::regex::Regex;
  
  let re = Regex::compile("(\\w+)@(\\w+)").unwrap();
  defer re.free();
  let caps = re.captures("user@example.com").unwrap();
  defer caps.free();
  assert_eq!(caps.get(0).unwrap(), "user@example");
  assert_eq!(caps.get(1).unwrap(), "user");
  assert_eq!(caps.get(2).unwrap(), "example");
  Run this example

• fn get_pos(self: &Captures, group: usize) -> Option<(usize, usize)>

  source

  Get the start and end positions of a capture group

  Example

  use std::regex::Regex;
  
  let re = Regex::compile("(\\d+)").unwrap();
  defer re.free();
  let caps = re.captures("abc123def").unwrap();
  defer caps.free();
  assert_eq!(caps.get_pos(1).unwrap(), (3usize, 6usize));
  Run this example

• fn len(self: &Captures) -> usize

  source

  Get the number of capture groups (including group 0 for full match)

  Example

  use std::regex::Regex;
  
  let re = Regex::compile("(\\w+)@(\\w+)").unwrap();
  defer re.free();
  let caps = re.captures("user@example.com").unwrap();
  defer caps.free();
  assert_eq!(caps.len(), 3); // Group 0 (full match) + 2 user groups
  Run this example

• fn move(self: &mut Captures) -> Captures

  source

  Creates a copy of the object, leaving an inert object behind.

  See Movable for details.

• fn free(self: &mut Captures)

  source

  Frees the memory backing the object.