Skip to content

Commit

Permalink
Add doc note about 'raws' encoding
Browse files Browse the repository at this point in the history
  • Loading branch information
ry committed Sep 11, 2009
1 parent d03c7e3 commit 5629fd5
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 20 deletions.
14 changes: 7 additions & 7 deletions doc/api.html
Original file line number Diff line number Diff line change
Expand Up @@ -55,12 +55,12 @@ <h2 id="_synopsis">SYNOPSIS</h2>
</div>
<h2 id="_api">API</h2>
<div class="sectionbody">
<div class="paragraph"><p>Node supports 3 byte-string encodings: ASCII (<tt>"ascii"</tt>), UTF-8 (<tt>"utf8"</tt>),
and raw binary (<tt>"raw"</tt>). It uses strings to represent ASCII and UTF-8
encoded data. For the moment, arrays of integers are used to represent raw
binary data&#8212;this representation is rather inefficient. This will
change in the future, when
<a href="http://code.google.com/p/v8/issues/detail?id=270">V8 supports Blob objects</a>.</p></div>
<div class="paragraph"><p>Node supports 4 byte-string encodings. ASCII (<tt>"ascii"</tt>), UTF-8 (<tt>"utf8"</tt>)
both use the string object, obviously. Then two "raw binary" encodings - one
uses an array of integers (<tt>"raw"</tt>) and the other uses a string (<tt>"raws"</tt>).
Neither raw encodings are perfect and thier implemenations are rather
inefficient. Hopefully the raw encoding situation will improve in the
future.</p></div>
<div class="paragraph"><p>Unless otherwise noted, functions are all asynchronous and do not block
execution.</p></div>
<h3 id="_helpers">Helpers</h3><div style="clear:left"></div>
Expand Down Expand Up @@ -1863,7 +1863,7 @@ <h2 id="_extension_api">Extension API</h2>
<div id="footer">
<div id="footer-text">
Version 0.1.9<br />
Last updated 2009-09-11 13:40:01 CEST
Last updated 2009-09-11 20:58:54 CEST
</div>
</div>
</body>
Expand Down
12 changes: 6 additions & 6 deletions doc/api.txt
Original file line number Diff line number Diff line change
Expand Up @@ -38,12 +38,12 @@ Server running at http://127.0.0.1:8000/

== API

Node supports 3 byte-string encodings: ASCII (+"ascii"+), UTF-8 (+"utf8"+),
and raw binary (+"raw"+). It uses strings to represent ASCII and UTF-8
encoded data. For the moment, arrays of integers are used to represent raw
binary data--this representation is rather inefficient. This will
change in the future, when
http://code.google.com/p/v8/issues/detail?id=270[V8 supports Blob objects].
Node supports 4 byte-string encodings. ASCII (+"ascii"+), UTF-8 (+"utf8"+)
both use the string object, obviously. Then two "raw binary" encodings - one
uses an array of integers (+"raw"+) and the other uses a string (+"raws"+).
Neither raw encodings are perfect and thier implemenations are rather
inefficient. Hopefully the raw encoding situation will improve in the
future.

Unless otherwise noted, functions are all asynchronous and do not block
execution.
Expand Down
9 changes: 2 additions & 7 deletions doc/node.1
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Server running at http://127\.0\.0\.1:8000/
.fi
.RE
.SH "API"
Node supports 3 byte\-string encodings: ASCII ("ascii"), UTF\-8 ("utf8"), and raw binary ("raw")\. It uses strings to represent ASCII and UTF\-8 encoded data\. For the moment, arrays of integers are used to represent raw binary data\(emthis representation is rather inefficient\. This will change in the future, when V8 supports Blob objects\.
Node supports 4 byte\-string encodings\. ASCII ("ascii"), UTF\-8 ("utf8") both use the string object, obviously\. Then two "raw binary" encodings \- one uses an array of integers ("raw") and the other uses a string ("raws")\. Neither raw encodings are perfect and thier implemenations are rather inefficient\. Hopefully the raw encoding situation will improve in the future\.
.sp
Unless otherwise noted, functions are all asynchronous and do not block execution\.
.sp
Expand Down Expand Up @@ -1774,16 +1774,11 @@ Further documentation will come soon\. For now see the source code of node_postg
.sp
.SH "NOTES"
.IP " 1." 4
V8 supports Blob objects
.RS 4
\%http://code.google.com/p/v8/issues/detail?id=270
.RE
.IP " 2." 4
here
.RS 4
\%http:/cvs.schmorp.de/libev/ev.html
.RE
.IP " 3." 4
.IP " 2." 4
node_postgres
.RS 4
\%http://github.com/ry/node_postgres
Expand Down

0 comments on commit 5629fd5

Please sign in to comment.