summaryrefslogtreecommitdiff
path: root/doc/matchdata/end.rdoc
diff options
context:
space:
mode:
authorBurdette Lamar <BurdetteLamar@Yahoo.com>2022-04-18 13:02:35 -0500
committerGitHub <noreply@github.com>2022-04-18 13:02:35 -0500
commitb074bc3d614cd4e783dc77e3602c424110230495 (patch)
tree20d2ffd9307486a3fb2fd780e0680bca1a5efcbd /doc/matchdata/end.rdoc
parent9d1dd7a9ed189475730254fbfee52f890759afaf (diff)
[DOC] Enhanced RDoc for MatchData (#5819)
Treats: #begin #end #match #match_length
Notes
Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
Diffstat (limited to 'doc/matchdata/end.rdoc')
-rw-r--r--doc/matchdata/end.rdoc30
1 files changed, 30 insertions, 0 deletions
diff --git a/doc/matchdata/end.rdoc b/doc/matchdata/end.rdoc
new file mode 100644
index 0000000000..0209b2d2fc
--- /dev/null
+++ b/doc/matchdata/end.rdoc
@@ -0,0 +1,30 @@
+Returns the offset (in characters) of the end of the specified match.
+
+When non-negative integer argument +n+ is given,
+returns the offset of the end of the <tt>n</tt>th match:
+
+ m = /(.)(.)(\d+)(\d)/.match("THX1138.")
+ # => #<MatchData "HX1138" 1:"H" 2:"X" 3:"113" 4:"8">
+ m[0] # => "HX1138"
+ m.end(0) # => 7
+ m[3] # => "113"
+ m.end(3) # => 6
+
+ m = /(т)(е)(с)/.match('тест')
+ # => #<MatchData "тес" 1:"т" 2:"е" 3:"с">
+ m[0] # => "тес"
+ m.end(0) # => 3
+ m[3] # => "с"
+ m.end(3) # => 3
+
+When string or symbol argument +name+ is given,
+returns the offset of the end for the named match:
+
+ m = /(?<foo>.)(.)(?<bar>.)/.match("hoge")
+ # => #<MatchData "hog" foo:"h" bar:"g">
+ m[:foo] # => "h"
+ m.end('foo') # => 1
+ m[:bar] # => "g"
+ m.end(:bar) # => 3
+
+Related: MatchData#begin, MatchData#offset, MatchData#byteoffset.