Module `Netstring_str`Source

Wrapper for regexps with Str syntax * * This module was written at a time when we had only the Str module * for regular expressions. However, Str has an interface that does * not work for multi-threaded programs, because the state of the module * is visible to the outside. The module Netstring_str is similar to Str, * but has a thread-compatible interface. * * For an explanation why we need this module, please read Regexp.

Supported regexp syntax * *

* .             matches every character but newline
* e*            matches e several times
* e+            matches e several times but at least once
* e?            matches e optionally
* e{m,n}        matches e at least m times and at most n times
* e1\|e2        matches e1 or e2
* [set]         matches the characters from set
* [^set]        matches the characters except from set
* \(...\)       group paranthesis
* \n            back reference (n is digit)
* ^             matches at beginning of line
* $             matches at end of line
*

* * This is exactly what Str supports. Character classes * are not implemented.

Sourcetype regexp

The type of regular expressions

Sourcetype split_result = Str.split_result =

| Text of string
| Delim of string

Sourcetype result

Sourceval regexp : string -> regexp

Parses a regexp

Sourceval regexp_case_fold : string -> regexp

Parses a regexp

Parses a case-insensitive regexp

Sourceval quote : string -> string

Parses a case-insensitive regexp

Quotes a string such that it can be included in a regexp

Sourceval regexp_string : string -> regexp

Quotes a string such that it can be included in a regexp

Returns a regexp that matches exactly the string

Sourceval regexp_string_case_fold : string -> regexp

Returns a regexp that matches exactly the string

Returns a case-insensitive regexp that matches exactly the string

Sourceval quote_set : string -> string

Returns a regexp (as string) that matches any of the characters in the argument. The argument must be non-empty

Sourceval string_match : regexp -> string -> int -> result option

Matches the string at the position with the regexp. Returns * None if no match is found. Returns Some r on success, * and r describes the match.

Sourceval bytes_match : regexp -> Bytes.t -> int -> result option

Same for bytes

Sourceval search_forward : regexp -> string -> int -> int * result

Searches a match of the string with the regexp, starting at * the position and in forward direction. * Raises Not_found if no match could be found. * Returns (p,r) when a match at position p is found, * described by r.

Sourceval search_forward_bytes : regexp -> Bytes.t -> int -> int * result

Same for bytes

Sourceval search_backward : regexp -> string -> int -> int * result

Searches a match of the string with the regexp, starting at * the position and in backward direction. * Raises Not_found if no match could be found. * Returns (p,r) when a match at position p is found, * described by r.

Sourceval search_backward_bytes : regexp -> Bytes.t -> int -> int * result

Same for bytes

Sourceval matched_string : result -> string -> string

Extracts the matched part from the string. The string argument * must be the same string passed to string_match or the search * functions, and the result argument must be the corresponding * result.

Sourceval matched_bytes : result -> Bytes.t -> Bytes.t

Same for bytes

Sourceval match_beginning : result -> int

Returns the position where the matched part begins

Sourceval match_end : result -> int

Returns the position where the matched part ends

Sourceval matched_group : result -> int -> string -> string

Extracts the substring the nth group matches from the whole * string. The string argument * must be the same string passed to string_match or the search * functions, and the result argument must be the corresponding * result.

Sourceval matched_group_bytes : result -> int -> Bytes.t -> Bytes.t

Same for bytes

Sourceval group_beginning : result -> int -> int

Returns the position where the substring matching the nth * group begins

Sourceval group_end : result -> int -> int

Returns the position where the substring matching the nth * group ends

Sourceval global_replace : regexp -> string -> string -> string

global_replace re templ s: Replaces all matchings of re in * s by templ. * * In templ one can refer to matched groups by the backslash notation: * \1 refers to the first group, \2 to the second etc. * \0 is the whole match. \\ is the backslash character.

Sourceval replace_first : regexp -> string -> string -> string

replace_first re templ s: Replaces the first match of re in * s by templ. * * In templ one can refer to matched groups by the backslash notation: * \1 refers to the first group, \2 to the second etc. * \0 is the whole match. \\ is the backslash character.

Source

val global_substitute : 
  regexp ->
  (result -> string -> string) ->
  string ->
  string

global_substitute re subst s: Applies the substitution function * subst to all matchings of re in s, and returns the * transformed string. subst is called with the current result * of the match and the whole string s.

Source

val substitute_first : 
  regexp ->
  (result -> string -> string) ->
  string ->
  string

substitute_first re subst s: Applies the substitution function * subst to the first matching of re in s, and returns the * transformed string. subst is called with the current result * of the match and the whole string s.

Sourceval split : regexp -> string -> string list

Splits the string according to the regexp in substrings. * Occurrences of the delimiter at the beginning and the end * are ignored.

Sourceval bounded_split : regexp -> string -> int -> string list

Splits into at most n substrings, based on split

Sourceval split_delim : regexp -> string -> string list

Splits into at most n substrings, based on split

Same as split, but occurrences of the delimiter at the beginning * and the end are returned as empty strings

Sourceval bounded_split_delim : regexp -> string -> int -> string list

Same as split, but occurrences of the delimiter at the beginning * and the end are returned as empty strings

Splits into at most n substrings, based on split_delim

Sourceval full_split : regexp -> string -> split_result list

Splits into at most n substrings, based on split_delim

Like split_delim, but returns the delimiters in the result

Sourceval bounded_full_split : regexp -> string -> int -> split_result list

Like split_delim, but returns the delimiters in the result

Splits into at most n substrings, based on full_split

Sourceval string_before : string -> int -> string

The first n characters of a string

Sourceval string_after : string -> int -> string

The first n characters of a string

The last n characters of a string

Sourceval first_chars : string -> int -> string

The last n characters of a string

Same as string_before

Sourceval last_chars : string -> int -> string

Same as string_before

Same as string_after

Sourcemodule Debug : sig ... end

Install

Dune Dependency

Authors

Maintainers

Sources

doc/gapi-ocaml.netstring-local/Netstring_str/index.html

Module `Netstring_str`Source

package gapi-ocaml

Install

Dune Dependency

Authors

Maintainers

Sources

doc/gapi-ocaml.netstring-local/Netstring_str/index.html

Module Netstring_strSource

Module `Netstring_str`Source