ProtoBuf.DotProto.Parser.html 8.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>JSDoc: Class: Parser</title>
  6. <script src="scripts/prettify/prettify.js"> </script>
  7. <script src="scripts/prettify/lang-css.js"> </script>
  8. <!--[if lt IE 9]>
  9. <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
  10. <![endif]-->
  11. <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
  12. <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
  13. </head>
  14. <body>
  15. <div id="main">
  16. <h1 class="page-title">Class: Parser</h1>
  17. <section>
  18. <header>
  19. <h2>
  20. <span class="ancestors"><a href="ProtoBuf.html">ProtoBuf</a><a href="ProtoBuf.DotProto.html">.DotProto</a>.</span>
  21. Parser
  22. </h2>
  23. <div class="class-description"><p>prototype parser</p></div>
  24. </header>
  25. <article>
  26. <div class="container-overview">
  27. <h2>Constructor</h2>
  28. <h4 class="name" id="Parser"><span class="type-signature"></span>new Parser<span class="signature">(source)</span><span class="type-signature"></span></h4>
  29. <div class="description">
  30. <p>Constructs a new Parser.</p>
  31. </div>
  32. <h5>Parameters:</h5>
  33. <table class="params">
  34. <thead>
  35. <tr>
  36. <th>Name</th>
  37. <th>Type</th>
  38. <th class="last">Description</th>
  39. </tr>
  40. </thead>
  41. <tbody>
  42. <tr>
  43. <td class="name"><code>source</code></td>
  44. <td class="type">
  45. <span class="param-type">string</span>
  46. </td>
  47. <td class="description last"><p>Source</p></td>
  48. </tr>
  49. </tbody>
  50. </table>
  51. <dl class="details">
  52. <dt class="tag-source">Source:</dt>
  53. <dd class="tag-source"><ul class="dummy"><li>
  54. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line688">line 688</a>
  55. </li></ul></dd>
  56. </dl>
  57. </div>
  58. <h3 class="subsection-title">Members</h3>
  59. <h4 class="name" id="proto3"><span class="type-signature"></span>proto3<span class="type-signature"> :boolean</span></h4>
  60. <div class="description">
  61. <p>Whether parsing proto3 or not.</p>
  62. </div>
  63. <h5>Type:</h5>
  64. <ul>
  65. <li>
  66. <span class="param-type">boolean</span>
  67. </li>
  68. </ul>
  69. <dl class="details">
  70. <dt class="tag-source">Source:</dt>
  71. <dd class="tag-source"><ul class="dummy"><li>
  72. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line701">line 701</a>
  73. </li></ul></dd>
  74. </dl>
  75. <h4 class="name" id="tn"><span class="type-signature">(non-null) </span>tn<span class="type-signature"> :<a href="ProtoBuf.DotProto.Tokenizer.html">ProtoBuf.DotProto.Tokenizer</a></span></h4>
  76. <div class="description">
  77. <p>Tokenizer.</p>
  78. </div>
  79. <h5>Type:</h5>
  80. <ul>
  81. <li>
  82. <span class="param-type"><a href="ProtoBuf.DotProto.Tokenizer.html">ProtoBuf.DotProto.Tokenizer</a></span>
  83. </li>
  84. </ul>
  85. <dl class="details">
  86. <dt class="tag-source">Source:</dt>
  87. <dd class="tag-source"><ul class="dummy"><li>
  88. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line695">line 695</a>
  89. </li></ul></dd>
  90. </dl>
  91. <h3 class="subsection-title">Methods</h3>
  92. <h4 class="name" id=".parse"><span class="type-signature">(static) </span>parse<span class="signature">()</span><span class="type-signature"> &rarr; (non-null) {Object}</span></h4>
  93. <div class="description">
  94. <p>Parses the specified source.</p>
  95. </div>
  96. <dl class="details">
  97. <dt class="tag-source">Source:</dt>
  98. <dd class="tag-source"><ul class="dummy"><li>
  99. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line796">line 796</a>
  100. </li></ul></dd>
  101. </dl>
  102. <h5>Throws:</h5>
  103. <dl>
  104. <dt>
  105. <div class="param-desc">
  106. <p>If the source cannot be parsed</p>
  107. </div>
  108. </dt>
  109. <dd></dd>
  110. <dt>
  111. <dl>
  112. <dt>
  113. Type
  114. </dt>
  115. <dd>
  116. <span class="param-type">Error</span>
  117. </dd>
  118. </dl>
  119. </dt>
  120. <dd></dd>
  121. </dl>
  122. <h5>Returns:</h5>
  123. <dl>
  124. <dt>
  125. Type
  126. </dt>
  127. <dd>
  128. <span class="param-type">Object</span>
  129. </dd>
  130. </dl>
  131. <h4 class="name" id="parse"><span class="type-signature"></span>parse<span class="signature">()</span><span class="type-signature"> &rarr; (non-null) {Object}</span></h4>
  132. <div class="description">
  133. <p>Parses the source.</p>
  134. </div>
  135. <dl class="details">
  136. <dt class="tag-source">Source:</dt>
  137. <dd class="tag-source"><ul class="dummy"><li>
  138. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line716">line 716</a>
  139. </li></ul></dd>
  140. </dl>
  141. <h5>Throws:</h5>
  142. <dl>
  143. <dt>
  144. <div class="param-desc">
  145. <p>If the source cannot be parsed</p>
  146. </div>
  147. </dt>
  148. <dd></dd>
  149. <dt>
  150. <dl>
  151. <dt>
  152. Type
  153. </dt>
  154. <dd>
  155. <span class="param-type">Error</span>
  156. </dd>
  157. </dl>
  158. </dt>
  159. <dd></dd>
  160. </dl>
  161. <h5>Returns:</h5>
  162. <dl>
  163. <dt>
  164. Type
  165. </dt>
  166. <dd>
  167. <span class="param-type">Object</span>
  168. </dd>
  169. </dl>
  170. <h4 class="name" id="toString"><span class="type-signature"></span>toString<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
  171. <div class="description">
  172. <p>Returns a string representation of this parser.</p>
  173. </div>
  174. <dl class="details">
  175. <dt class="tag-source">Source:</dt>
  176. <dd class="tag-source"><ul class="dummy"><li>
  177. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1373">line 1373</a>
  178. </li></ul></dd>
  179. </dl>
  180. <h5>Returns:</h5>
  181. <dl>
  182. <dt>
  183. Type
  184. </dt>
  185. <dd>
  186. <span class="param-type">string</span>
  187. </dd>
  188. </dl>
  189. </article>
  190. </section>
  191. </div>
  192. <nav>
  193. <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="ProtoBuf.Builder.html">Builder</a></li><li><a href="ProtoBuf.Builder.Message.html">Message</a></li><li><a href="ProtoBuf.Builder.Service.html">Service</a></li><li><a href="ProtoBuf.DotProto.Parser.html">Parser</a></li><li><a href="ProtoBuf.DotProto.Tokenizer.html">Tokenizer</a></li><li><a href="ProtoBuf.Map.html">Map</a></li><li><a href="ProtoBuf.Reflect.Element.html">Element</a></li><li><a href="ProtoBuf.Reflect.Enum.html">Enum</a></li><li><a href="ProtoBuf.Reflect.Enum.Value.html">Value</a></li><li><a href="ProtoBuf.Reflect.Extension.html">Extension</a></li><li><a href="ProtoBuf.Reflect.Message.html">Message</a></li><li><a href="ProtoBuf.Reflect.Message.ExtensionField.html">ExtensionField</a></li><li><a href="ProtoBuf.Reflect.Message.Field.html">Field</a></li><li><a href="ProtoBuf.Reflect.Message.OneOf.html">OneOf</a></li><li><a href="ProtoBuf.Reflect.Namespace.html">Namespace</a></li><li><a href="ProtoBuf.Reflect.Service.html">Service</a></li><li><a href="ProtoBuf.Reflect.Service.Method.html">Method</a></li><li><a href="ProtoBuf.Reflect.Service.RPCMethod.html">RPCMethod</a></li><li><a href="ProtoBuf.Reflect.T.html">T</a></li></ul><h3>Namespaces</h3><ul><li><a href="ProtoBuf.html">ProtoBuf</a></li><li><a href="ProtoBuf.DotProto.html">DotProto</a></li><li><a href="ProtoBuf.Reflect.html">Reflect</a></li><li><a href="ProtoBuf.Util.html">Util</a></li></ul>
  194. </nav>
  195. <br class="clear">
  196. <footer>
  197. Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.3</a> on Fri Jan 27 2017 17:03:55 GMT+0100 (Mitteleuropäische Zeit)
  198. </footer>
  199. <script> prettyPrint(); </script>
  200. <script src="scripts/linenumber.js"> </script>
  201. </body>
  202. </html>