Module regex/index

regex/index

Regular expression engine with an NFA-based virtual machine.

Types

Regex object
Regex

Compiled regular expression backed by an NFA program.

Fields

NameTypeDescription
_programNfaProgram
_flagsRegexFlags
_patternString
_n_groupsusize
_group_namesArrayList(GroupNameEntry)
impl(Regex, ...)
new : (Regex) fn(pattern : String, flags_str : String) -> Result(Regex, String)

Parameters

NameTypeNotes
patternString
flags_strString

Returns: Result(Regex, String)

source : (Regex) fn(self : Regex) -> String

Parameters

NameTypeNotes
selfRegex

Returns: String

_extract_substring : (Regex) fn(self : Regex, bytes : ArrayList(u8), start : usize, end_pos : usize) -> String

Parameters

NameTypeNotes
selfRegex
bytesArrayList(u8)
startusize
end_posusize

Returns: String

_byte_to_char_index : (Regex) fn(self : Regex, bytes : ArrayList(u8), byte_pos : usize) -> usize

Parameters

NameTypeNotes
selfRegex
bytesArrayList(u8)
byte_posusize

Returns: usize

_find_prefix_pos : (Regex) fn(self : Regex, input_bytes : ArrayList(u8), from_byte : usize) -> usize

Parameters

NameTypeNotes
selfRegex
input_bytesArrayList(u8)
from_byteusize

Returns: usize

impl(Regex, ...)
_build_match : (Regex) fn(self : Regex, slots : ArrayList(usize), input : String) -> RegexMatch

Parameters

NameTypeNotes
selfRegex
slotsArrayList(usize)
inputString

Returns: RegexMatch

impl(Regex, ...)
exec : (Regex) fn(self : Regex, input : String) -> Option(RegexMatch)

Parameters

NameTypeNotes
selfRegex
inputString

Returns: Option(RegexMatch)

match_all : (Regex) fn(self : Regex, input : String) -> ArrayList(RegexMatch)

Parameters

NameTypeNotes
selfRegex
inputString

Returns: ArrayList(RegexMatch)

impl(Regex, ...)
test : (Regex) fn(self : Regex, input : String) -> bool

Parameters

NameTypeNotes
selfRegex
inputString

Returns: bool

impl(Regex, ...)
_apply_replacement : (Regex) fn(self : Regex, replacement : String, m : RegexMatch) -> String

Parameters

NameTypeNotes
selfRegex
replacementString
mRegexMatch

Returns: String

impl(Regex, ...)
replace : (Regex) fn(self : Regex, input : String, replacement : String) -> String

Parameters

NameTypeNotes
selfRegex
inputString
replacementString

Returns: String

replace_all : (Regex) fn(self : Regex, input : String, replacement : String) -> String

Parameters

NameTypeNotes
selfRegex
inputString
replacementString

Returns: String

split : (Regex) fn(self : Regex, input : String) -> ArrayList(String)

Parameters

NameTypeNotes
selfRegex
inputString

Returns: ArrayList(String)

RegexMatch object
RegexMatch

Fields

NameTypeDescription
_valueString
_indexusize
_inputString
_groupsArrayList(Option(String))
_group_namesArrayList(GroupNameEntry)
Methods
new : (RegexMatch) fn(value : String, index : usize, input : String, groups : ArrayList(Option(String)), group_names : ArrayList(GroupNameEntry)) -> RegexMatch

Parameters

NameTypeNotes
valueString
indexusize
inputString
groupsArrayList(Option(String))
group_namesArrayList(GroupNameEntry)

Returns: RegexMatch

value : (RegexMatch) fn(self : RegexMatch) -> String

Parameters

NameTypeNotes
selfRegexMatch

Returns: String

index : (RegexMatch) fn(self : RegexMatch) -> usize

Parameters

NameTypeNotes
selfRegexMatch

Returns: usize

input : (RegexMatch) fn(self : RegexMatch) -> String

Parameters

NameTypeNotes
selfRegexMatch

Returns: String

group : (RegexMatch) fn(self : RegexMatch, idx : usize) -> Option(String)

Parameters

NameTypeNotes
selfRegexMatch
idxusize

Returns: Option(String)

named_group : (RegexMatch) fn(self : RegexMatch, name : String) -> Option(String)

Parameters

NameTypeNotes
selfRegexMatch
nameString

Returns: Option(String)

group_count : (RegexMatch) fn(self : RegexMatch) -> usize

Parameters

NameTypeNotes
selfRegexMatch

Returns: usize

RegexFlags struct
RegexFlags

Fields

NameTypeDescription
globalbool
ignore_casebool
multilinebool
dot_allbool
unicodebool
stickybool
Methods
default : (RegexFlags) fn() -> RegexFlags

Returns: RegexFlags

parse : (RegexFlags) fn(flags_str : String) -> Result(RegexFlags, String)

Parameters

NameTypeNotes
flags_strString

Returns: Result(RegexFlags, String)