Module Re.GroupSource

Manipulate matching groups.

Manipulate matching groups.

Sourcetype t = Group.t

Information about groups in a match. As is conventional, every match implicitly has a group 0 that covers the whole match, and explicit groups are numbered from 1.

Sourceval get : t -> int -> string

Raise Not_found if the group did not match

Sourceval get_opt : t -> int -> string option

Similar to get, but returns an option instead of using an exception.

Sourceval offset : t -> int -> int * int

Raise Not_found if the group did not match

Sourceval offset_opt : t -> int -> (int * int) option

Similar to offset, but returns an option instead of using an exception.

Sourceval start : t -> int -> int

Return the start of the match. Raise Not_found if the group did not match.

Sourceval start_opt : t -> int -> int option

Similar to start_opt, but returns an option instead of using an exception.

Sourceval stop : t -> int -> int

Return the end of the match. Raise Not_found if the group did not match.

Sourceval stop_opt : t -> int -> int option

Similar to stop_opt, but returns an option instead of using an exception.

Sourceval all : t -> string array

Return the empty string for each group which did not match

Sourceval all_offset : t -> (int * int) array

Return (-1,-1) for each group which did not match

Sourceval test : t -> int -> bool

Test whether a group matched

Sourceval nb_groups : t -> int

Returns the total number of groups defined - matched or not. This function is experimental.

Sourceval pp : Format.formatter -> t -> unit