Farkle


Regex Module

F#-friendly members of the `Regex` class. Please consult the members of the `Regex` class for documentation.

Functions and values

Function or value Description

allButChars str

Full Usage: allButChars str

Parameters:
    str : char seq

Returns: Regex

An alias for `Regex.NotOneOf`.

str : char seq
Returns: Regex

any

Full Usage: any

Returns: Regex

An alias for `Regex.Any`. See the documentation of it for caveats.

Returns: Regex

atLeast num x

Full Usage: atLeast num x

Parameters:
Returns: Regex
num : int
x : Regex
Returns: Regex

between from upTo x

Full Usage: between from upTo x

Parameters:
    from : int
    upTo : int
    x : Regex

Returns: Regex
from : int
upTo : int
x : Regex
Returns: Regex

char c

Full Usage: char c

Parameters:
    c : char

Returns: Regex

An alias for `Regex.Literal` that takes a character.

c : char
Returns: Regex

chars str

Full Usage: chars str

Parameters:
    str : char seq

Returns: Regex

An alias for `Regex.OneOf`.

str : char seq
Returns: Regex

choice xs

Full Usage: choice xs

Parameters:
Returns: Regex
xs : Regex seq
Returns: Regex

concat xs

Full Usage: concat xs

Parameters:
Returns: Regex
xs : Regex seq
Returns: Regex

optional x

Full Usage: optional x

Parameters:
Returns: Regex
x : Regex
Returns: Regex

plus x

Full Usage: plus x

Parameters:
Returns: Regex

An alias for `atLeast 1`. The name alludes to the plus symbol of regular expressions.

x : Regex
Returns: Regex

regexString x

Full Usage: regexString x

Parameters:
    x : string

Returns: Regex
x : string
Returns: Regex

repeat num x

Full Usage: repeat num x

Parameters:
Returns: Regex
num : int
x : Regex
Returns: Regex

star x

Full Usage: star x

Parameters:
Returns: Regex

An alias for `Regex.ZeroOrMore`. The name alludes to the Kleene Star.

x : Regex
Returns: Regex

string str

Full Usage: string str

Parameters:
    str : string

Returns: Regex

An alias for `Regex.Literal` that takes a string.

str : string
Returns: Regex