Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
tree: 00ef296637
Fetching contributors…

Cannot retrieve contributors at this time

1537 lines (526 sloc) 17.635 kb
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: Deserializers</title>
<script src="http://shjs.sourceforge.net/sh_main.min.js"> </script>
<script src="http://shjs.sourceforge.net/lang/sh_javascript.min.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/node-dark.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Class: Deserializers</h1>
<section>
<header>
<h2>
Deserializers
</h2>
</header>
<article>
<div class="container-overview">
<dt>
<h4 class="name" id="Deserializers"><span class="type-signature"></span>new Deserializers</h4>
</dt>
<dd>
<p class="description">
Deserializers for various types
</p>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>deserializers.js, line 8</li></ul></dd>
</dl>
</dd>
</div>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<h4 class="name" id="decodeAscii"><span class="type-signature">&lt;static> </span>decodeAscii</h4>
</dt>
<dd>
<p class="description">
Decodes for Ascii
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>val</code></td>
<td class="type">
String
</td>
<td class="description last">The binary string to decode</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>deserializers.js, line 70</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The ascii value decoded from the binary string
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">String</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="decodeBinary"><span class="type-signature">&lt;static> </span>decodeBinary</h4>
</dt>
<dd>
<p class="description">
Does binary decoding
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>val</code></td>
<td class="type">
String
</td>
<td class="description last">The binary string to decode</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>deserializers.js, line 25</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
a buffer containing the bytes decoded from the string
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Buffer</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="decodeBoolean"><span class="type-signature">&lt;static> </span>decodeBoolean</h4>
</dt>
<dd>
<p class="description">
Decodes a boolean type
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>val</code></td>
<td class="type">
String
</td>
<td class="description last">The binary string to decode</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>deserializers.js, line 111</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The boolean value decoded from the binary string
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Boolean</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="decodeDate"><span class="type-signature">&lt;static> </span>decodeDate</h4>
</dt>
<dd>
<p class="description">
Decodes a Date object
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>val</code></td>
<td class="type">
String
</td>
<td class="description last">The binary string to decode</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>deserializers.js, line 130</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The date value decoded from the binary string
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Date</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="decodeDouble"><span class="type-signature">&lt;static> </span>decodeDouble</h4>
</dt>
<dd>
<p class="description">
Decode a Double Precision Floating Point Type
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>val</code></td>
<td class="type">
String
</td>
<td class="description last">The binary string to decode</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>deserializers.js, line 83</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The number value decoded from the binary string
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Number</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="decodeFloat"><span class="type-signature">&lt;static> </span>decodeFloat</h4>
</dt>
<dd>
<p class="description">
Decode a Single Precision Floating Point Type
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>val</code></td>
<td class="type">
String
</td>
<td class="description last">The binary string to decode</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>deserializers.js, line 97</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The number value decoded from the binary string
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Number</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="decodeInt32"><span class="type-signature">&lt;static> </span>decodeInt32</h4>
</dt>
<dd>
<p class="description">
Decodes a 32bit Unsinged Integer
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>val</code></td>
<td class="type">
String
</td>
<td class="description last">The binary string to decode</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>deserializers.js, line 48</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The number value decoded from the binary string
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Number</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="decodeLong"><span class="type-signature">&lt;static> </span>decodeLong</h4>
</dt>
<dd>
<p class="description">
Decodes a Long (UInt64)
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>val</code></td>
<td class="type">
String
</td>
<td class="description last">The binary string to decode</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>deserializers.js, line 39</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The number value decoded from the binary string
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Number</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="decodeTimeUUID"><span class="type-signature">&lt;static> </span>decodeTimeUUID</h4>
</dt>
<dd>
<p class="description">
Decodes a TimeUUID Object
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>val</code></td>
<td class="type">
String
</td>
<td class="description last">The binary string to decode</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>deserializers.js, line 157</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The uuid value decoded from the binary string
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">TimeUUID</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="decodeUTF8"><span class="type-signature">&lt;static> </span>decodeUTF8</h4>
</dt>
<dd>
<p class="description">
Decodes for UTF8
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>val</code></td>
<td class="type">
String
</td>
<td class="description last">The binary string to decode</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>deserializers.js, line 57</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The utf8 value decoded from the binary string
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">String</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="decodeUUID"><span class="type-signature">&lt;static> </span>decodeUUID</h4>
</dt>
<dd>
<p class="description">
Decodes a UUID Object
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>val</code></td>
<td class="type">
String
</td>
<td class="description last">The binary string to decode</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>deserializers.js, line 144</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The uuid value decoded from the binary string
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">UUID</span>
</dd>
</dl>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h3>Classes</h3><ul><li><a href="Column.html">Column</a></li><li><a href="ColumnFamily.html">ColumnFamily</a></li><li><a href="Connection.html">Connection</a></li><li><a href="Deserializers.html">Deserializers</a></li><li><a href="Helenus.html">Helenus</a></li><li><a href="Keyspace.html">Keyspace</a></li><li><a href="Marshal.html">Marshal</a></li><li><a href="Pool.html">Pool</a></li><li><a href="Row.html">Row</a></li><li><a href="Serializers.html">Serializers</a></li><li><a href="TimeUUID.html">TimeUUID</a></li><li><a href="UUID.html">UUID</a></li></ul>
</nav>
<br clear="both">
<footer>
Documentation generated by <a href="https://github.com/micmath/jsdoc">JSDoc 3</a> on Fri Apr 20 2012 11:58:20 GMT-0400 (EDT)
</footer>
<script> sh_highlightDocument(); </script>
</body>
</html>
Jump to Line
Something went wrong with that request. Please try again.