.\" This man page is automatically generated using
.\" kayadoc2man from the Kaya development tools and the -xmldocs compile 
.\" option. Editing it directly is not encouraged.
.\" It is under the same license as the source .k file that it was
.\" generated from.
.TH "Regex.match" "3kaya" "August 2014" "Kaya" "Kaya module reference"
.SH "NAME"
Regex::match \- Attempt to match a regular expression.
.SH "SYNOPSIS"
.B Match match(
\fIRegex x, String str\fP
.B ")"
.SH "ARGUMENTS"
.PP
.B "x"
A compiled regular expression
.PP
.B "str"
The String to match
.SH "DESCRIPTION"
.PP
Attempt to match a compiled regular expression to a string, returning a
.B "Regex.Match"(3kaya)
object.
.IP "" -4
 r = compile("s$");
 s1 = "sausages";
 m1 = match(r,s1); // matches(["s"],"sausage","")
 s2 = "a sausage";
 m2 = match(r,s2); // noMatch
.SH "AUTHORS"
Kaya standard library by Edwin Brady, Chris Morris and others (kaya@kayalang.org). For further information see http://kayalang.org/
.SH LICENSE
The Kaya standard library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License (version 2.1 or any later version) as published by the Free Software Foundation.
.SH "RELATED"
.PD 0
.PP
.B "Regex.compile"(3kaya)
.PP
.B "Regex.quickMatch"(3kaya)
.PP
.B "Regex.quickMatch_1"(3kaya)
.PD 0.4v