package re

  1. Overview
  2. Docs
On This Page
  1. Deprecated
Legend:
Library
Module
Module type
Parameter
Class
Class type
type regexp = Re.re
type flag = [
  1. | `CASELESS
  2. | `MULTILINE
  3. | `ANCHORED
]
type groups = Re.groups
type split_result =
  1. | Text of string
    (*

    Text part of splitted string

    *)
  2. | Delim of string
    (*

    Delimiter part of splitted string

    *)
  3. | Group of int * string
    (*

    Subgroup of matched delimiter (subgroup_nr, subgroup_str)

    *)
  4. | NoGroup
    (*

    Unmatched subgroup

    *)

Result of a Pcre.full_split

val re : ?flags:flag list -> string -> Re.t

re ~flags s creates the regexp s using the pcre syntax.

val regexp : ?flags:flag list -> string -> regexp

re ~flags s compiles the regexp s using the pcre syntax.

val extract : rex:regexp -> string -> string array

extract ~rex s executes rex on s and returns the matching groups.

val exec : rex:regexp -> ?pos:int -> string -> groups

Equivalent to Re.exec.

val get_substring : groups -> int -> string

Equivalent to Re.Group.get.

val get_substring_ofs : groups -> int -> int * int

Equivalent to Re.Group.offset.

val pmatch : rex:regexp -> string -> bool

Equivalent to Re.execp.

val substitute : rex:Re.re -> subst:(string -> string) -> string -> string
val full_split : ?max:int -> rex:regexp -> string -> split_result list
val split : rex:regexp -> string -> string list
val quote : string -> string

Deprecated

type substrings = Re.groups