RubyGems - fakeldap - Versions diffs - 0.0.0 → 0.0.1 - Mend

fakeldap 0.0.0 → 0.0.1

Files changed (81) hide show

data/vendor/ruby-ldapserver/doc/LDAP/Server/Syntax.html ADDED

@@ -0,0 +1,1254 @@
+<!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" xml:lang="en" lang="en">
+  <head>
+    <meta name="Content-Type" content="text/html; charset=utf-8" />
+<title>Class: LDAP::Server::Syntax</title>
+<link rel="stylesheet" href="../../css/style.css" type="text/css" media="screen" charset="utf-8" />
+<link rel="stylesheet" href="../../css/common.css" type="text/css" media="screen" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  relpath = '../..';
+  if (relpath != '') 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>
+    <script type="text/javascript" charset="utf-8">
+      if (window.top.frames.main) document.body.className = 'frames';
+    </script>
+    <div id="header">
+      <div id="menu">
+    <a href="../../_index.html">Index (S)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../../LDAP.html" title="LDAP (module)">LDAP</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Server.html" title="LDAP::Server (class)">Server</a></span></span>
+     &raquo;
+    <span class="title">Syntax</span>
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+      <div id="search">
+  <a id="class_list_link" href="#">Class List</a>
+  <a id="method_list_link" href="#">Method List</a>
+  <a id ="file_list_link" href="#">File List</a>
+</div>
+      <div class="clear"></div>
+    </div>
+    <iframe id="search_frame"></iframe>
+    <div id="content"><h1>Class: LDAP::Server::Syntax
+</h1>
+<dl class="box">
+    <dt class="r1">Inherits:</dt>
+    <dd class="r1">
+      <span class="inheritName">Object</span>
+        <ul class="fullTree">
+          <li>Object</li>
+            <li class="next">LDAP::Server::Syntax</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      </dd>
+    <dt class="r2 last">Defined in:</dt>
+    <dd class="r2 last">lib/ldap/server/syntax.rb<span class="defines">,<br />
+  lib/ldap/server/syntax.rb</span>
+</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>
+A class which describes LDAP SyntaxDescriptions. For now there is a global
+pool of Syntax objects (rather than each Schema object having its own set)
+</p>
+  </div>
+</div>
+<div class="tags">
+</div>
+  <h2>Constant Summary</h2>
+    <dl class="constants">
+        <dt id="KEYSTR-constant" class="">KEYSTR =
+          <div class="docstring">
+  <div class="discussion">
+    <p>
+Shared constants for regexp-based syntax parsers
+</p>
+  </div>
+</div>
+<div class="tags">
+</div>
+        </dt>
+        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>[a-zA-Z][a-zA-Z0-9;-]*</span><span class='tstring_end'>&quot;</span></span></pre></dd>
+        <dt id="NUMERICOID-constant" class="">NUMERICOID =
+        </dt>
+        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>( \\d[\\d.]+\\d )</span><span class='tstring_end'>&quot;</span></span></pre></dd>
+        <dt id="WOID-constant" class="">WOID =
+        </dt>
+        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\\s* ( </span><span class='embexpr_beg'>#{</span><span class='const'>KEYSTR</span><span class='rbrace'>}</span><span class='tstring_content'> | \\d[\\d.]+\\d ) \\s*</span><span class='tstring_end'>&quot;</span></span></pre></dd>
+        <dt id="OIDS-constant" class="">OIDS =
+        </dt>
+        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>( </span><span class='embexpr_beg'>#{</span><span class='id _WOID'>_WOID</span><span class='rbrace'>}</span><span class='tstring_content'> | \\s* \\( </span><span class='embexpr_beg'>#{</span><span class='id _WOID'>_WOID</span><span class='rbrace'>}</span><span class='tstring_content'> (?: \\$ </span><span class='embexpr_beg'>#{</span><span class='id _WOID'>_WOID</span><span class='rbrace'>}</span><span class='tstring_content'> )* \\) \\s* )</span><span class='tstring_end'>&quot;</span></span></pre></dd>
+        <dt id="QDESCRS-constant" class="">QDESCRS =
+        </dt>
+        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>( </span><span class='embexpr_beg'>#{</span><span class='id _QDESCR'>_QDESCR</span><span class='rbrace'>}</span><span class='tstring_content'> | \\s* \\( (?:</span><span class='embexpr_beg'>#{</span><span class='id _QDESCR'>_QDESCR</span><span class='rbrace'>}</span><span class='tstring_content'>)+ \\) \\s* )</span><span class='tstring_end'>&quot;</span></span></pre></dd>
+        <dt id="QDSTRING-constant" class="">QDSTRING =
+        </dt>
+        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\\s* ' (.*?) ' \\s*</span><span class='tstring_end'>&quot;</span></span></pre></dd>
+        <dt id="NOIDLEN-constant" class="">NOIDLEN =
+        </dt>
+        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>(\\d[\\d.]+\\d) (?: \\{ (\\d+) \\} )?</span><span class='tstring_end'>&quot;</span></span></pre></dd>
+        <dt id="ATTRIBUTEUSAGE-constant" class="">ATTRIBUTEUSAGE =
+        </dt>
+        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>(userApplications|directoryOperation|distributedOperation|dSAOperation)</span><span class='tstring_end'>&quot;</span></span></pre></dd>
+        <dt id="AttributeTypeDescription-constant" class="">AttributeTypeDescription =
+          <div class="docstring">
+  <div class="discussion">
+    <p>
+These are the &#8216;SHOULD&#8217; support syntaxes from RFC2252 section 6
+</p>
+  </div>
+</div>
+<div class="tags">
+</div>
+        </dt>
+        <dd><pre class="code"><span class='id add'>add</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>1.3.6.1.4.1.1466.115.121.1.3</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Attribute Type Description</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='symbol'>:re</span><span class='op'>=&gt;</span>
+<span class='tstring'><span class='regexp_beg'>%r!</span><span class='tstring_content'> \A \s* \( \s*
+</span><span class='tstring_content'> </span><span class='embexpr_beg'>#{</span><span class='const'>NUMERICOID</span><span class='rbrace'>}</span><span class='tstring_content'> \s*
+</span><span class='tstring_content'>	(?: NAME </span><span class='embexpr_beg'>#{</span><span class='const'>QDESCRS</span><span class='rbrace'>}</span><span class='tstring_content'> )?
+</span><span class='tstring_content'>	(?: DESC </span><span class='embexpr_beg'>#{</span><span class='const'>QDSTRING</span><span class='rbrace'>}</span><span class='tstring_content'> )?
+	(   OBSOLETE \s* )?
+</span><span class='tstring_content'>	(?: SUP </span><span class='embexpr_beg'>#{</span><span class='const'>WOID</span><span class='rbrace'>}</span><span class='tstring_content'> )?
+</span><span class='tstring_content'>	(?: EQUALITY </span><span class='embexpr_beg'>#{</span><span class='const'>WOID</span><span class='rbrace'>}</span><span class='tstring_content'> )?
+</span><span class='tstring_content'>	(?: ORDERING </span><span class='embexpr_beg'>#{</span><span class='const'>WOID</span><span class='rbrace'>}</span><span class='tstring_content'> )?
+</span><span class='tstring_content'>	(?: SUBSTR </span><span class='embexpr_beg'>#{</span><span class='const'>WOID</span><span class='rbrace'>}</span><span class='tstring_content'> )?
+</span><span class='tstring_content'>	(?: SYNTAX \s* </span><span class='embexpr_beg'>#{</span><span class='const'>NOIDLEN</span><span class='rbrace'>}</span><span class='tstring_content'> \s* )?	# capture 2
+	(   SINGLE-VALUE \s* )?
+	(   COLLECTIVE \s* )?
+	(   NO-USER-MODIFICATION \s* )?
+</span><span class='tstring_content'>	(?: USAGE \s* </span><span class='embexpr_beg'>#{</span><span class='const'>ATTRIBUTEUSAGE</span><span class='rbrace'>}</span><span class='tstring_content'> )?
+</span><span class='tstring_content'>\s* \) \s* \z </span><span class='regexp_end'>!xu</span></span><span class='rparen'>)</span></pre></dd>
+        <dt id="MatchingRuleDescription-constant" class="">MatchingRuleDescription =
+        </dt>
+        <dd><pre class="code"><span class='id add'>add</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>1.3.6.1.4.1.1466.115.121.1.30</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Matching Rule Description</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='symbol'>:re</span><span class='op'>=&gt;</span>
+<span class='tstring'><span class='regexp_beg'>%r!</span><span class='tstring_content'> \A \s* \( \s*
+</span><span class='tstring_content'> </span><span class='embexpr_beg'>#{</span><span class='const'>NUMERICOID</span><span class='rbrace'>}</span><span class='tstring_content'> \s*
+</span><span class='tstring_content'>	(?: NAME </span><span class='embexpr_beg'>#{</span><span class='const'>QDESCRS</span><span class='rbrace'>}</span><span class='tstring_content'> )?
+</span><span class='tstring_content'>	(?: DESC </span><span class='embexpr_beg'>#{</span><span class='const'>QDSTRING</span><span class='rbrace'>}</span><span class='tstring_content'> )?
+	(   OBSOLETE \s* )?
+</span><span class='tstring_content'> SYNTAX \s* </span><span class='embexpr_beg'>#{</span><span class='const'>NUMERICOID</span><span class='rbrace'>}</span><span class='tstring_content'> \s*
+</span><span class='tstring_content'>\s* \) \s* \z </span><span class='regexp_end'>!xu</span></span><span class='rparen'>)</span></pre></dd>
+        <dt id="MatchingRuleUseDescription-constant" class="">MatchingRuleUseDescription =
+        </dt>
+        <dd><pre class="code"><span class='id add'>add</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>1.3.6.1.4.1.1466.115.121.1.31</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Matching Rule Use Description</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='symbol'>:re</span><span class='op'>=&gt;</span>
+<span class='tstring'><span class='regexp_beg'>%r!</span><span class='tstring_content'> \A \s* \( \s*
+</span><span class='tstring_content'> </span><span class='embexpr_beg'>#{</span><span class='const'>NUMERICOID</span><span class='rbrace'>}</span><span class='tstring_content'> \s*
+</span><span class='tstring_content'>	(?: NAME </span><span class='embexpr_beg'>#{</span><span class='const'>QDESCRS</span><span class='rbrace'>}</span><span class='tstring_content'> )?
+</span><span class='tstring_content'>	(?: DESC </span><span class='embexpr_beg'>#{</span><span class='const'>QDSTRING</span><span class='rbrace'>}</span><span class='tstring_content'> )?
+	(   OBSOLETE \s* )?
+</span><span class='tstring_content'> APPLIES \s* </span><span class='embexpr_beg'>#{</span><span class='const'>OIDS</span><span class='rbrace'>}</span><span class='tstring_content'> \s*
+</span><span class='tstring_content'>\s* \) \s* \z </span><span class='regexp_end'>!xu</span></span><span class='rparen'>)</span></pre></dd>
+        <dt id="ObjectClassDescription-constant" class="">ObjectClassDescription =
+        </dt>
+        <dd><pre class="code"><span class='id add'>add</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>1.3.6.1.4.1.1466.115.121.1.37</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Object Class Description</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='symbol'>:re</span><span class='op'>=&gt;</span>
+<span class='tstring'><span class='regexp_beg'>%r!</span><span class='tstring_content'> \A \s* \( \s*
+</span><span class='tstring_content'>	</span><span class='embexpr_beg'>#{</span><span class='const'>NUMERICOID</span><span class='rbrace'>}</span><span class='tstring_content'> \s*
+</span><span class='tstring_content'>	(?: NAME </span><span class='embexpr_beg'>#{</span><span class='const'>QDESCRS</span><span class='rbrace'>}</span><span class='tstring_content'> )?
+</span><span class='tstring_content'>	(?: DESC </span><span class='embexpr_beg'>#{</span><span class='const'>QDSTRING</span><span class='rbrace'>}</span><span class='tstring_content'> )?
+	(   OBSOLETE \s* )?
+</span><span class='tstring_content'>	(?: SUP </span><span class='embexpr_beg'>#{</span><span class='const'>OIDS</span><span class='rbrace'>}</span><span class='tstring_content'> )?
+	(?: ( ABSTRACT|STRUCTURAL|AUXILIARY ) \s* )?
+</span><span class='tstring_content'>	(?: MUST </span><span class='embexpr_beg'>#{</span><span class='const'>OIDS</span><span class='rbrace'>}</span><span class='tstring_content'> )?
+</span><span class='tstring_content'>	(?: MAY </span><span class='embexpr_beg'>#{</span><span class='const'>OIDS</span><span class='rbrace'>}</span><span class='tstring_content'> )?
+</span><span class='tstring_content'>\s* \) \s* \z </span><span class='regexp_end'>!xu</span></span><span class='rparen'>)</span></pre></dd>
+        <dt id="LDAPSyntaxDescription-constant" class="">LDAPSyntaxDescription =
+        </dt>
+        <dd><pre class="code"><span class='id add'>add</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>1.3.6.1.4.1.1466.115.121.1.54</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>LDAP Syntax Description</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='symbol'>:re</span><span class='op'>=&gt;</span>
+<span class='tstring'><span class='regexp_beg'>%r!</span><span class='tstring_content'> \A \s* \( \s*
+</span><span class='tstring_content'> </span><span class='embexpr_beg'>#{</span><span class='const'>NUMERICOID</span><span class='rbrace'>}</span><span class='tstring_content'> \s*
+</span><span class='tstring_content'>	(?: DESC </span><span class='embexpr_beg'>#{</span><span class='const'>QDSTRING</span><span class='rbrace'>}</span><span class='tstring_content'> )?
+	(?: X-BINARY-TRANSFER-REQUIRED \s* ' (TRUE|FALSE) ' \s* )?
+	(?: X-NOT-HUMAN-READABLE \s* ' (TRUE|FALSE) ' \s* )?
+</span><span class='tstring_content'>\s* \) \s* \z </span><span class='regexp_end'>!xu</span></span><span class='rparen'>)</span></pre></dd>
+        <dt id="syntaxes-classvariable" class="">@@syntaxes =
+        </dt>
+        <dd><pre class="code"><span class='lbrace'>{</span><span class='rbrace'>}</span></pre></dd>
+    </dl>
+  <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
+  <ul class="summary">
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#binary-instance_method" title="#binary (instance method)">- (Object) <strong>binary</strong> </a>
+  </span>
+    <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>
+Returns the value of attribute binary.
+</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#desc-instance_method" title="#desc (instance method)">- (Object) <strong>desc</strong> </a>
+  </span>
+    <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>
+Returns the value of attribute desc.
+</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#nhr-instance_method" title="#nhr (instance method)">- (Object) <strong>nhr</strong> </a>
+  </span>
+    <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>
+Returns the value of attribute nhr.
+</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#oid-instance_method" title="#oid (instance method)">- (Object) <strong>oid</strong> </a>
+  </span>
+    <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>
+Returns the value of attribute oid.
+</p>
+</div></span>
+</li>
+  </ul>
+    <h2>
+      Class Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
+    <ul class="summary">
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#add-class_method" title="add (class method)">+ (Object) <strong>add</strong>(*args, &amp;blk) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>
+Add a new syntax definition.
+</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#all_syntaxes-class_method" title="all_syntaxes (class method)">+ (Object) <strong>all_syntaxes</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>
+Return all known syntax objects.
+</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#find-class_method" title="find (class method)">+ (Object) <strong>find</strong>(oid) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>
+Find a Syntax object given an oid.
+</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#from_def-class_method" title="from_def (class method)">+ (Object) <strong>from_def</strong>(str, &amp;blk) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>
+Create a new Syntax object, given its description string.
+</p>
+</div></span>
+</li>
+    </ul>
+    <h2>
+      Instance Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
+    <ul class="summary">
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#initialize-instance_method" title="#initialize (instance method)">- (Syntax) <strong>initialize</strong>(oid, desc = nil, opt = {}, &amp;blk) </a>
+  </span>
+    <span class="note title constructor">constructor</span>
+    <span class="summary_desc"><div class='inline'><p>
+Create a new Syntax object.
+</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#match-instance_method" title="#match (instance method)">- (Object) <strong>match</strong>(val) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>
+Return true or a MatchData object if the given value is allowed by this
+syntax.
+</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#to_def-instance_method" title="#to_def (instance method)">- (Object) <strong>to_def</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>
+Convert this object to its description string.
+</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#to_s-instance_method" title="#to_s (instance method)">- (Object) <strong>to_s</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'></div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#value_from_s-instance_method" title="#value_from_s (instance method)">- (Object) <strong>value_from_s</strong>(val) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>
+Convert a string value for this syntax into a Ruby-like value (not yet
+used, but seemed like a good idea).
+</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#value_to_s-instance_method" title="#value_to_s (instance method)">- (Object) <strong>value_to_s</strong>(val) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>
+Convert a value for this syntax into its canonical string representation
+(not yet used, but seemed like a good idea).
+</p>
+</div></span>
+</li>
+    </ul>
+<div id="constructor_details" class="method_details_list">
+  <h2>Constructor Details</h2>
+    <div class="method_details first">
+  <p class="signature first" id="initialize-instance_method">
+    - (<tt><span class='object_link'><a href="" title="LDAP::Server::Syntax (class)">Syntax</a></span></tt>) <strong>initialize</strong>(oid, desc = nil, opt = {}, &amp;blk)
+</p><div class="docstring">
+  <div class="discussion">
+    <p>
+Create a new Syntax object
+</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+13
+14
+15
+16
+17
+18
+19
+20
+21</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ldap/server/syntax.rb', line 13</span>
+<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id oid'>oid</span><span class='comma'>,</span> <span class='id desc'>desc</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id opt'>opt</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id blk'>blk</span><span class='rparen'>)</span>
+  <span class='ivar'>@oid</span> <span class='op'>=</span> <span class='id oid'>oid</span>
+  <span class='ivar'>@desc</span> <span class='op'>=</span> <span class='id desc'>desc</span>
+  <span class='ivar'>@nhr</span> <span class='op'>=</span> <span class='id opt'>opt</span><span class='lbracket'>[</span><span class='symbol'>:nhr</span><span class='rbracket'>]</span>		<span class='comment'># not human-readable?
+</span>  <span class='ivar'>@binary</span> <span class='op'>=</span> <span class='id opt'>opt</span><span class='lbracket'>[</span><span class='symbol'>:binary</span><span class='rbracket'>]</span>	<span class='comment'># binary encoding forced?
+</span>  <span class='ivar'>@re</span> <span class='op'>=</span> <span class='id opt'>opt</span><span class='lbracket'>[</span><span class='symbol'>:re</span><span class='rbracket'>]</span>		<span class='comment'># regular expression for parsing
+</span>  <span class='ivar'>@def</span> <span class='op'>=</span> <span class='kw'>nil</span>
+  <span class='id instance_eval'>instance_eval</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id blk'>blk</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id blk'>blk</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+</div>
+  <div id="instance_attr_details" class="attr_details">
+    <h2>Instance Attribute Details</h2>
+      <span id=""></span>
+      <span id="binary-instance_method"></span>
+      <div class="method_details first">
+  <p class="signature first" id="binary-instance_method">
+    - (<tt>Object</tt>) <strong>binary</strong>  <span class="extras">(readonly)</span>
+</p><div class="docstring">
+  <div class="discussion">
+    <p>
+Returns the value of attribute binary
+</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+9
+10
+11</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ldap/server/syntax.rb', line 9</span>
+<span class='kw'>def</span> <span class='id binary'>binary</span>
+  <span class='ivar'>@binary</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id=""></span>
+      <span id="desc-instance_method"></span>
+      <div class="method_details ">
+  <p class="signature " id="desc-instance_method">
+    - (<tt>Object</tt>) <strong>desc</strong>  <span class="extras">(readonly)</span>
+</p><div class="docstring">
+  <div class="discussion">
+    <p>
+Returns the value of attribute desc
+</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+9
+10
+11</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ldap/server/syntax.rb', line 9</span>
+<span class='kw'>def</span> <span class='id desc'>desc</span>
+  <span class='ivar'>@desc</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id=""></span>
+      <span id="nhr-instance_method"></span>
+      <div class="method_details ">
+  <p class="signature " id="nhr-instance_method">
+    - (<tt>Object</tt>) <strong>nhr</strong>  <span class="extras">(readonly)</span>
+</p><div class="docstring">
+  <div class="discussion">
+    <p>
+Returns the value of attribute nhr
+</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+9
+10
+11</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ldap/server/syntax.rb', line 9</span>
+<span class='kw'>def</span> <span class='id nhr'>nhr</span>
+  <span class='ivar'>@nhr</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id=""></span>
+      <span id="oid-instance_method"></span>
+      <div class="method_details ">
+  <p class="signature " id="oid-instance_method">
+    - (<tt>Object</tt>) <strong>oid</strong>  <span class="extras">(readonly)</span>
+</p><div class="docstring">
+  <div class="discussion">
+    <p>
+Returns the value of attribute oid
+</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+9
+10
+11</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ldap/server/syntax.rb', line 9</span>
+<span class='kw'>def</span> <span class='id oid'>oid</span>
+  <span class='ivar'>@oid</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+  <div id="class_method_details" class="method_details_list">
+    <h2>Class Method Details</h2>
+      <div class="method_details first">
+  <p class="signature first" id="add-class_method">
+    + (<tt>Object</tt>) <strong>add</strong>(*args, &amp;blk)
+</p><div class="docstring">
+  <div class="discussion">
+    <p>
+Add a new syntax definition
+</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+75
+76
+77
+78</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ldap/server/syntax.rb', line 75</span>
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id add'>add</span><span class='lparen'>(</span><span class='op'>*</span><span class='id args'>args</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id blk'>blk</span><span class='rparen'>)</span>
+  <span class='id s'>s</span> <span class='op'>=</span> <span class='id new'>new</span><span class='lparen'>(</span><span class='op'>*</span><span class='id args'>args</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id blk'>blk</span><span class='rparen'>)</span>
+  <span class='cvar'>@@syntaxes</span><span class='lbracket'>[</span><span class='id s'>s</span><span class='period'>.</span><span class='id oid'>oid</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id s'>s</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <p class="signature " id="all_syntaxes-class_method">
+    + (<tt>Object</tt>) <strong>all_syntaxes</strong>
+</p><div class="docstring">
+  <div class="discussion">
+    <p>
+Return all known syntax objects
+</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+91
+92
+93</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ldap/server/syntax.rb', line 91</span>
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id all_syntaxes'>all_syntaxes</span>
+  <span class='cvar'>@@syntaxes</span><span class='period'>.</span><span class='id values'>values</span><span class='period'>.</span><span class='id uniq'>uniq</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <p class="signature " id="find-class_method">
+    + (<tt>Object</tt>) <strong>find</strong>(oid)
+</p><div class="docstring">
+  <div class="discussion">
+    <p>
+Find a Syntax object given an oid. If not known, return a new empty Syntax
+object associated with this oid.
+</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+83
+84
+85
+86
+87</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ldap/server/syntax.rb', line 83</span>
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id find'>find</span><span class='lparen'>(</span><span class='id oid'>oid</span><span class='rparen'>)</span>
+  <span class='kw'>return</span> <span class='id oid'>oid</span> <span class='kw'>if</span> <span class='id oid'>oid</span><span class='period'>.</span><span class='id nil?'>nil?</span> <span class='kw'>or</span> <span class='id oid'>oid</span><span class='period'>.</span><span class='id is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>LDAP</span><span class='op'>::</span><span class='const'>Server</span><span class='op'>::</span><span class='const'>Syntax</span><span class='rparen'>)</span>
+  <span class='kw'>return</span> <span class='cvar'>@@syntaxes</span><span class='lbracket'>[</span><span class='id oid'>oid</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='cvar'>@@syntaxes</span><span class='lbracket'>[</span><span class='id oid'>oid</span><span class='rbracket'>]</span>
+  <span class='id add'>add</span><span class='lparen'>(</span><span class='id oid'>oid</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <p class="signature " id="from_def-class_method">
+    + (<tt>Object</tt>) <strong>from_def</strong>(str, &amp;blk)
+</p><div class="docstring">
+  <div class="discussion">
+    <p>
+Create a new Syntax object, given its description string
+</p>
+  </div>
+</div>
+<div class="tags">
+  <h3>Raises:</h3>
+<ul class="raise">
+    <li>
+        <span class='type'>(<tt><span class='object_link'><a href="../ResultError/InvalidAttributeSyntax.html" title="LDAP::ResultError::InvalidAttributeSyntax (class)">LDAP::ResultError::InvalidAttributeSyntax</a></span></tt>)</span>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+29
+30
+31
+32
+33
+34</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ldap/server/syntax.rb', line 29</span>
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id from_def'>from_def</span><span class='lparen'>(</span><span class='id str'>str</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id blk'>blk</span><span class='rparen'>)</span>
+  <span class='id m'>m</span> <span class='op'>=</span> <span class='const'>LDAPSyntaxDescription</span><span class='period'>.</span><span class='id match'>match</span><span class='lparen'>(</span><span class='id str'>str</span><span class='rparen'>)</span>
+  <span class='id raise'>raise</span> <span class='const'>LDAP</span><span class='op'>::</span><span class='const'>ResultError</span><span class='op'>::</span><span class='const'>InvalidAttributeSyntax</span><span class='comma'>,</span>
+    <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Bad SyntaxTypeDescription </span><span class='embexpr_beg'>#{</span><span class='id str'>str</span><span class='period'>.</span><span class='id inspect'>inspect</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>unless</span> <span class='id m'>m</span>
+  <span class='id new'>new</span><span class='lparen'>(</span><span class='id m'>m</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id m'>m</span><span class='lbracket'>[</span><span class='int'>2</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='symbol'>:nhr</span><span class='op'>=&gt;</span><span class='lparen'>(</span><span class='id m'>m</span><span class='lbracket'>[</span><span class='int'>3</span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>TRUE</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='comma'>,</span> <span class='symbol'>:binary</span><span class='op'>=&gt;</span><span class='lparen'>(</span><span class='id m'>m</span><span class='lbracket'>[</span><span class='int'>4</span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>TRUE</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id blk'>blk</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+  <div id="instance_method_details" class="method_details_list">
+    <h2>Instance Method Details</h2>
+      <div class="method_details first">
+  <p class="signature first" id="match-instance_method">
+    - (<tt>Object</tt>) <strong>match</strong>(val)
+</p><div class="docstring">
+  <div class="discussion">
+    <p>
+Return true or a MatchData object if the given value is allowed by this
+syntax
+</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+52
+53
+54
+55</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ldap/server/syntax.rb', line 52</span>
+<span class='kw'>def</span> <span class='id match'>match</span><span class='lparen'>(</span><span class='id val'>val</span><span class='rparen'>)</span>
+  <span class='kw'>return</span> <span class='kw'>true</span> <span class='kw'>if</span> <span class='ivar'>@re</span><span class='period'>.</span><span class='id nil?'>nil?</span>
+  <span class='ivar'>@re</span><span class='period'>.</span><span class='id match'>match</span><span class='lparen'>(</span><span class='id value_to_s'>value_to_s</span><span class='lparen'>(</span><span class='id val'>val</span><span class='rparen'>)</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <p class="signature " id="to_def-instance_method">
+    - (<tt>Object</tt>) <strong>to_def</strong>
+</p><div class="docstring">
+  <div class="discussion">
+    <p>
+Convert this object to its description string
+</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+38
+39
+40
+41
+42
+43
+44
+45
+46
+47</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ldap/server/syntax.rb', line 38</span>
+<span class='kw'>def</span> <span class='id to_def'>to_def</span>
+  <span class='kw'>return</span> <span class='ivar'>@def</span> <span class='kw'>if</span> <span class='ivar'>@def</span>
+  <span class='id ans'>ans</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>( </span><span class='embvar'>#</span><span class='ivar'>@oid</span><span class='tstring_content'> </span><span class='tstring_end'>&quot;</span></span>
+  <span class='id ans'>ans</span> <span class='op'>&lt;&lt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>DESC '</span><span class='embvar'>#</span><span class='ivar'>@desc</span><span class='tstring_content'>' </span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='ivar'>@desc</span>
+  <span class='comment'># These are OpenLDAP extensions
+</span>  <span class='id ans'>ans</span> <span class='op'>&lt;&lt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>X-BINARY-TRANSFER-REQUIRED 'TRUE' </span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='ivar'>@binary</span>
+  <span class='id ans'>ans</span> <span class='op'>&lt;&lt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>X-NOT-HUMAN-READABLE 'TRUE' </span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='ivar'>@nhr</span>
+  <span class='id ans'>ans</span> <span class='op'>&lt;&lt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>)</span><span class='tstring_end'>&quot;</span></span>
+  <span class='ivar'>@def</span> <span class='op'>=</span> <span class='id ans'>ans</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <p class="signature " id="to_s-instance_method">
+    - (<tt>Object</tt>) <strong>to_s</strong>
+</p><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+23
+24
+25</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ldap/server/syntax.rb', line 23</span>
+<span class='kw'>def</span> <span class='id to_s'>to_s</span>
+  <span class='ivar'>@oid</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <p class="signature " id="value_from_s-instance_method">
+    - (<tt>Object</tt>) <strong>value_from_s</strong>(val)
+</p><div class="docstring">
+  <div class="discussion">
+    <p>
+Convert a string value for this syntax into a Ruby-like value (not yet
+used, but seemed like a good idea)
+</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+67
+68
+69</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ldap/server/syntax.rb', line 67</span>
+<span class='kw'>def</span> <span class='id value_from_s'>value_from_s</span><span class='lparen'>(</span><span class='id val'>val</span><span class='rparen'>)</span>
+  <span class='id val'>val</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <p class="signature " id="value_to_s-instance_method">
+    - (<tt>Object</tt>) <strong>value_to_s</strong>(val)
+</p><div class="docstring">
+  <div class="discussion">
+    <p>
+Convert a value for this syntax into its canonical string representation
+(not yet used, but seemed like a good idea)
+</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+60
+61
+62</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ldap/server/syntax.rb', line 60</span>
+<span class='kw'>def</span> <span class='id value_to_s'>value_to_s</span><span class='lparen'>(</span><span class='id val'>val</span><span class='rparen'>)</span>
+  <span class='id val'>val</span><span class='period'>.</span><span class='id to_s'>to_s</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+    <div id="footer">
+  Generated on Mon Sep 13 13:27:16 2010 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.6.0 (ruby-1.9.2).
+</div>
+  </body>
+</html>