pages/ldoc/o/modules/INSPECT.html

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
    <title>Zenroom LUA</title>
    <link rel="stylesheet" href="" type="text/css" />
</head>
<body>

<div id="container">

<div id="product">
	<div id="product_logo"></div>
	<div id="product_name"><big><b></b></big></div>
	<div id="product_description"></div>
</div> <!-- id="product" -->


<div id="main">


<!-- Menu -->

<div id="navigation">
<br/>
<h1>Zenroom</h1>

<ul>
  <li><a href="../index.html">Index</a></li>
</ul>

<h2>Contents</h2>
<ul>
<li><a href="#Functions">Functions</a></li>
</ul>


<h2>Modules</h2>
<ul class="nowrap">
  <li><a href="../modules/OCTET.html">OCTET</a></li>
  <li><a href="../modules/HASH.html">HASH</a></li>
  <li><a href="../modules/ECDH.html">ECDH</a></li>
  <li><a href="../modules/ECP.html">ECP</a></li>
  <li><a href="../modules/String.html">String</a></li>
  <li><a href="../modules/Table.html">Table</a></li>
  <li><strong>INSPECT</strong></li>
  <li><a href="../modules/ZEN.html">ZEN</a></li>
  <li><a href="../modules/BIG.html">BIG</a></li>
</ul>
<h2>Examples</h2>
<ul class="nowrap">
  <li><a href="../examples/keygen.lua.html">keygen.lua</a></li>
  <li><a href="../examples/crypt-to-multi.lua.html">crypt-to-multi.lua</a></li>
</ul>

</div>

<div id="content">

<h1>Module <code>INSPECT</code></h1>
<p>

<h1>Debug inspection facility</h1>


<p> The INSPECT class provides a number of functions to ease
 development and debugging.</p>
</p>
<p> It mainly consists of an advanced
 <a href="../modules/INSPECT.html#print">print</a> function that can represent complex data structures (Lua
 tables) and tag their encoding formats and size.  Another <a href="../modules/INSPECT.html#spy">spy</a>
 function prints the same as pass-through.</p>
    <h3>Info:</h3>
    <ul>
        <li><strong>License</strong>: MIT</li>
        <li><strong>Author</strong>: Kikito <a href="http://github.com/kikito/inspect.lua">github.com/kikito/inspect.lua</a></li>
    </ul>


<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
	<tr>
	<td class="name" nowrap><a href="#print">print (object)</a></td>
	<td class="summary">Print all contents of a table in a tree representation, works with
 complex data structures and prints to STDOUT.</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#warn">warn (object)</a></td>
	<td class="summary">Print all contents of a table to STDERR.</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#spy">spy (object)</a></td>
	<td class="summary">Print all contents of a table to STDERR and return same object as
 passthrough.</td>
	</tr>
</table>

<br/>
<br/>


    <h2 class="section-header "><a name="Functions"></a>Functions</h2>

    <dl class="function">
    <dt>
    <a name = "print"></a>
    <strong>print (object)</strong>
    </dt>
    <dd>
    Print all contents of a table in a tree representation, works with
 complex data structures and prints to STDOUT. (object)


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">object</span>
         complex table data structure
        </li>
    </ul>


</dd>
    <dt>
    <a name = "warn"></a>
    <strong>warn (object)</strong>
    </dt>
    <dd>
    Print all contents of a table to STDERR.  Works same way as <a href="../modules/INSPECT.html#print">print</a>.
(object)


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">object</span>
         complex table data structure
        </li>
    </ul>


</dd>
    <dt>
    <a name = "spy"></a>
    <strong>spy (object)</strong>
    </dt>
    <dd>
    Print all contents of a table to STDERR and return same object as
 passthrough.  Works same way as <a href="../modules/INSPECT.html#print">print</a>.
(object)


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">object</span>
         complex table data structure
        </li>
    </ul>

    <h3>Returns:</h3>
    <ol>

        object itself (passthrough for nesting)
    </ol>


</dd>
</dl>


</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2020-03-13 12:59:05 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>