UNPKG

uri-template-router

Version:

Match a URI to a pattern in a collection of URI Templates

62 lines (60 loc) 3.37 kB
<?xml version="1.0" ?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <title>regexptree.rb</title> </head> <body> <h1><a name="label-0" id="label-0">RegexpTree</a></h1><!-- RDLabel: "RegexpTree" --> <p>RegexpTree represents regular expression. It can be converted to Regexp.</p> <h2><a name="label-1" id="label-1">class methods</a></h2><!-- RDLabel: "class methods" --> <dl> <dt><a name="label-2" id="label-2"><code>RegexpTree.str(<var>string</var>)</code></a></dt><!-- RDLabel: "RegexpTree.str" --> <dd> returns an instance of RegexpTree which only matches <var>string</var></dd> <dt><a name="label-3" id="label-3"><code>RegexpTree.alt(*<var>regexp_trees</var>)</code></a></dt><!-- RDLabel: "RegexpTree.alt" --> <dd> returns an instance of RegexpTree which is alternation of <var>regexp_trees</var>.</dd> <dt><a name="label-4" id="label-4"><code>RegexpTree.seq(*<var>regexp_trees</var>)</code></a></dt><!-- RDLabel: "RegexpTree.seq" --> <dd> returns an instance of RegexpTree which is concatination of <var>regexp_trees</var>.</dd> <dt><a name="label-5" id="label-5"><code>RegexpTree.rep(<var>regexp_tree</var>, <var>min</var>=<var>0</var>, <var>max</var>=<var>nil</var>, <var>greedy</var>=<var>true</var>)</code></a></dt><!-- RDLabel: "RegexpTree.rep" --> <dd> returns an instance of RegexpTree which is reptation of <var>regexp_tree</var>.</dd> <dt><a name="label-6" id="label-6"><code>RegexpTree.charclass(<var>natset</var>)</code></a></dt><!-- RDLabel: "RegexpTree.charclass" --> <dd> returns an instance of RegexpTree which matches characters in <var>natset</var>.</dd> </dl> <h2><a name="label-7" id="label-7">methods</a></h2><!-- RDLabel: "methods" --> <dl> <dt><a name="label-8" id="label-8"><code>regexp(<var>anchored</var>=<var>false</var>)</code></a></dt><!-- RDLabel: "regexp" --> <dd> <p>convert to Regexp.</p> <p>If <var>anchored</var> is true, the Regexp is anchored by <code>\A</code> and <code>\z</code>.</p></dd> <dt><a name="label-9" id="label-9"><code>to_s</code></a></dt><!-- RDLabel: "to_s" --> <dd> convert to String.</dd> <dt><a name="label-10" id="label-10"><code>empty_set?</code></a></dt><!-- RDLabel: "empty_set?" --> <dd> returns true iff self never matches. </dd> <dt><a name="label-11" id="label-11"><code>empty_sequence?</code></a></dt><!-- RDLabel: "empty_sequence?" --> <dd> returns true iff self only matches empty string.</dd> <dt><a name="label-12" id="label-12"><code><var>self</var> | <var>other</var></code></a></dt><!-- RDLabel: "self | other" --> <dd> returns alternation of <var>self</var> and <var>other</var>.</dd> <dt><a name="label-13" id="label-13"><code><var>self</var> + <var>other</var></code></a></dt><!-- RDLabel: "self + other" --> <dd> returns concatination of <var>self</var> and <var>other</var>.</dd> <dt><a name="label-14" id="label-14"><code><var>self</var> * <var>n</var></code></a></dt><!-- RDLabel: "self * n" --> <dd> returns <var>n</var> times repetation of <var>self</var>.</dd> <dt><a name="label-15" id="label-15"><code>rep(<var>min</var>=<var>0</var>, <var>max</var>=<var>nil</var>, <var>greedy</var>=<var>true</var>)</code></a></dt><!-- RDLabel: "rep" --> <dd> returns <var>min</var> to <var>max</var> times repetation of <var>self</var>.</dd> </dl> </body> </html>