rsre-lua 0.2.0

lua bindings for the rust regex crate
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111

-- SPDX-License-Identifier: MIT

---@meta rsre

local rsre = {}

---@class (exact) rsre.Match: userdata
rsre.Match = {}

--- Get the 1-indexed start position of the match (inclusive).
---
---@return integer
function rsre.Match:start() end

--- Get the 1-indexed stop position of the match (exclusive).
---
---@return integer
function rsre.Match:stop() end

--- Get the start and stop positions of the match.
---
---@see rsre.Match.start()
---@see rsre.Match.stop()
---
---@return integer, integer
function rsre.Match:range() end

--- Get the matched substring.
---
---@return string
function rsre.Match:as_str() end

---@class (exact) rsre.Captures: userdata
rsre.Captures = {}

--- Get the match at the provided index.
---
---@param index integer
---
---@return rsre.Match
function rsre.Captures:get(index) end

--- Get match with the provided name.
---
---@param name string
---
---@return rsre.Match
function rsre.Captures:name(name) end

--- Get the total number of matches.
---
---@return integer
function rsre.Captures:len() end

---@class (exact) rsre.Regex: userdata
---@field new fun(pattern: string): rsre.Regex
rsre.Regex = {}

--- Compile a new regex.
---
---@param pattern string
---
---@return rsre.Regex
function rsre.Regex.new(pattern) end

--- Test if the regex matches the provided string.
---
---@param hay string
---
---@return boolean
function rsre.Regex:match(hay) end

--- Find the first, leftmost match after `pos`.
---
---@param hay string
---@param pos? integer
---
---@return rsre.Match
function rsre.Regex:find(hay, pos) end

--- Find the first, leftmost captures after `pos`.
---
---@param hay string
---@param pos? integer
---
---@return rsre.Captures
function rsre.Regex:captures(hay, pos) end

--- Replace matches in `text` with `rep`, optionally up to `limit` times.
---
---@param text string
---@param rep string
---@param limit? integer
---
---@return string
function rsre.Regex:replace(text, rep, limit) end

--- Split a string at every match, optionally up to `limit` times.
---
---@param text string
---@param limit? integer
---
---@return string[]
function rsre.Regex:split(text, limit) end

--- The original regex as a string.
---
---@return string
function rsre.Regex:as_str() end

return rsre