landline/doc/Hyde/Util/HeaderRegexp.html

274 lines
11 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Hyde::Util::HeaderRegexp
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::Util::HeaderRegexp";
relpath = '../../';
</script>
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (H)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Util.html" title="Hyde::Util (module)">Util</a></span></span>
&raquo;
<span class="title">HeaderRegexp</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: Hyde::Util::HeaderRegexp
</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/util/parseutils.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>(not exactly precise) Regular expressions for some RFC definitions</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>
<dl class="constants">
<dt id="TOKEN-constant" class="">TOKEN =
<div class="docstring">
<div class="discussion">
<p>Matches the RFC2616 definiton of token</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>[!-~&amp;&amp;[^()&lt;&gt;@,;:\\&quot;\/\[\]?={}\t]]+</span><span class='regexp_end'>/</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
<dt id="QUOTED-constant" class="">QUOTED =
<div class="docstring">
<div class="discussion">
<p>Matches the RFC2616 definition of quoted-string</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>&quot;[\x0-\x7E&amp;&amp;[^\x1-\x8\xb-\x1f]]*(?&lt;!\\)&quot;</span><span class='regexp_end'>/</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
<dt id="PRINTCHAR-constant" class="">PRINTCHAR =
<div class="docstring">
<div class="discussion">
<p>Matches any CHAR except CTLs</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>[\x2-\x7E]</span><span class='regexp_end'>/</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
<dt id="PRINTABLE-constant" class="">PRINTABLE =
<div class="docstring">
<div class="discussion">
<p>Matches 1 or more CHARs excluding CTLs</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='tstring'><span class='regexp_beg'>/</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#PRINTCHAR-constant" title="Hyde::Util::HeaderRegexp::PRINTCHAR (constant)">PRINTCHAR</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>+</span><span class='regexp_end'>/o</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
<dt id="COOKIE_OCTET-constant" class="">COOKIE_OCTET =
<div class="docstring">
<div class="discussion">
<p>Matches the RFC6265 definition of a cookie-octet</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>[\x21-\x7E&amp;&amp;[^&quot;,;\\]]*</span><span class='regexp_end'>/</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
<dt id="COOKIE_VALUE-constant" class="">COOKIE_VALUE =
</dt>
<dd><pre class="code"><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>(?:</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#QUOTED-constant" title="Hyde::Util::HeaderRegexp::QUOTED (constant)">QUOTED</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>|</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#COOKIE_OCTET-constant" title="Hyde::Util::HeaderRegexp::COOKIE_OCTET (constant)">COOKIE_OCTET</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>)</span><span class='regexp_end'>/o</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
<dt id="COOKIE_NAME-constant" class="">COOKIE_NAME =
</dt>
<dd><pre class="code"><span class='const'><span class='object_link'><a href="#TOKEN-constant" title="Hyde::Util::HeaderRegexp::TOKEN (constant)">TOKEN</a></span></span></pre></dd>
<dt id="COOKIE_PAIR-constant" class="">COOKIE_PAIR =
<div class="docstring">
<div class="discussion">
<p>Matches the RFC6265 definition of cookie-pair.
Captures name (1) and value (2).</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>\A(</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#COOKIE_NAME-constant" title="Hyde::Util::HeaderRegexp::COOKIE_NAME (constant)">COOKIE_NAME</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>)=(</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#COOKIE_VALUE-constant" title="Hyde::Util::HeaderRegexp::COOKIE_VALUE (constant)">COOKIE_VALUE</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>)\Z</span><span class='regexp_end'>/o</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
<dt id="PARAM_QUOTED-constant" class="">PARAM_QUOTED =
<div class="docstring">
<div class="discussion">
<p>Matches a very abstract definition of a quoted header paramter.
Captures name (1) and value (2).</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>\A(</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#TOKEN-constant" title="Hyde::Util::HeaderRegexp::TOKEN (constant)">TOKEN</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>)=?(</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#QUOTED-constant" title="Hyde::Util::HeaderRegexp::QUOTED (constant)">QUOTED</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>|</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#PRINTCHAR-constant" title="Hyde::Util::HeaderRegexp::PRINTCHAR (constant)">PRINTCHAR</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>*)\Z</span><span class='regexp_end'>/o</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
<dt id="PARAM-constant" class="">PARAM =
<div class="docstring">
<div class="discussion">
<p>Matches a very abstract definition of a header parameter.
Captures name (1) and value (2).</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>\A(</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#TOKEN-constant" title="Hyde::Util::HeaderRegexp::TOKEN (constant)">TOKEN</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>)=?(</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#PRINTCHAR-constant" title="Hyde::Util::HeaderRegexp::PRINTCHAR (constant)">PRINTCHAR</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>*)\Z</span><span class='regexp_end'>/o</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
<dt id="COOKIE_PARAM-constant" class="">COOKIE_PARAM =
<div class="docstring">
<div class="discussion">
<p>Specifically matches cookie parameters</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>\A(</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#TOKEN-constant" title="Hyde::Util::HeaderRegexp::TOKEN (constant)">TOKEN</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>)=?(</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#QUOTED-constant" title="Hyde::Util::HeaderRegexp::QUOTED (constant)">QUOTED</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>|</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#COOKIE_OCTET-constant" title="Hyde::Util::HeaderRegexp::COOKIE_OCTET (constant)">COOKIE_OCTET</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>)\Z</span><span class='regexp_end'>/o</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
</dl>
</div>
<div id="footer">
Generated on Sun Sep 17 00:23:45 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>