Creates a new data reader for reading data from the given source.
-The source to read from.
-Returns the default encoding of the reader.
+Reads all kind of data values from the specified source.
+Creates a new data reader for reading data from the given source.
+The source to read from.
+Returns the default endianness of the reader.
-the default endianness used when no endianness is specified as parameter to the various read methods.
-Executes the given operation as a look-ahead operation. So any reading from the reader is a look-ahead and the +
Returns the default endianness of the reader.
+the default endianness used when no endianness is specified as parameter to the various read methods.
+Executes the given operation as a look-ahead operation. So any reading from the reader is a look-ahead and the stream position will be reset when operation is finished. Look-ahead operations can be nested.
Note that while reading data in a look-ahead operation buffers read from the stream pile up in memory because it is not possible to seek in a stream. So the only way to rewind to the previous position in the stream is to remember all the buffers read since then. So keep look-ahead operations short so in the best case the operation takes place in the same or the next buffer.
-Reads a signed 64 bit value.
-Optional endianness. Defaults to endianness the reader was configured with.
-Reads an array of signed 64 bit values.
+Reads a signed 64 bit value.
+Optional endianness. Defaults to endianness the reader was configured with.
+Reads an array of signed 64 bit values.
The buffer to write the read bytes to.
-Optional options: ReadMultiByteArrayOptionsOptional read array option.
+Optional options: ReadMultiByteArrayOptionsOptional read array option.
the number of read 16 bit values. 0 when end of stream is reached or 0 bytes were requested to read.
-Reads a unsigned 64 bit value.
-Optional endianness. Defaults to endianness the reader was configured with.
-Reads an array of unsigned 64 bit values.
+Reads a unsigned 64 bit value.
+Optional endianness. Defaults to endianness the reader was configured with.
+Reads an array of unsigned 64 bit values.
The buffer to write the read bytes to.
-Optional read array option.
+Optional read array option.
the number of read 16 bit values. 0 when end of stream is reached or 0 bytes were requested to read.
-Reads and returns a single bit from the stream.
+Reads the given number of bits and returns them as a number array.
+Reads the given number of bits and returns them as a number array.
TODO This can be optimized by reading the bits directly from the buffer instead of asynchronously reading bit by bit.
The number of bits to read.
The read bits. Empty array when end of stream has been reached without reading any bit.
-Reads a signed 16 bit value.
-Optional endianness. Defaults to endianness the reader was configured with.
-Reads an array of signed 16 bit values.
+Reads a signed 16 bit value.
+Optional endianness. Defaults to endianness the reader was configured with.
+Reads an array of signed 16 bit values.
The buffer to write the read bytes to.
-Optional options: ReadMultiByteArrayOptionsOptional read array option.
+Optional options: ReadMultiByteArrayOptionsOptional read array option.
the number of read 16 bit values. 0 when end of stream is reached or 0 bytes were requested to read.
-Reads a signed 32 bit value.
-Optional endianness. Defaults to endianness the reader was configured with.
-Reads an array of signed 32 bit values.
+Reads a signed 32 bit value.
+Optional endianness. Defaults to endianness the reader was configured with.
+Reads an array of signed 32 bit values.
The buffer to write the read bytes to.
-Optional options: ReadMultiByteArrayOptionsOptional read array option.
+Optional options: ReadMultiByteArrayOptionsOptional read array option.
the number of read 16 bit values. 0 when end of stream is reached or 0 bytes were requested to read.
-Reads and returns an signed 8 bit value.
+Reads an array of signed 8 bit values.
+Reads an array of signed 8 bit values.
The buffer to write the read bytes to.
Offset within the buffer to start writing to. Defaults to 0.
Number of bytes to read. Defaults to buffer size minus offset.
the number of read bytes. 0 when end of stream is reached or 0 bytes were requested to read.
-Reads a line from the stream. EOL marker can be defined in the options and by default stops at CRLF or LF +
Reads a line from the stream. EOL marker can be defined in the options and by default stops at CRLF or LF without including the EOL marker in the returned string.
-the read line. Null when end of stream is reached.
-Reads a null-terminated string from the stream.
-the read line. Null when end of stream is reached.
-Reads a string from the stream.
+the read line. Null when end of stream is reached.
+Reads a null-terminated string from the stream.
+the read line. Null when end of stream is reached.
+Reads a string from the stream.
The maximum number of bytes to read. Only in ASCII encoding this is the same as the length of the string. In other encodings the returned string may be shorter.
The encoding. Defaults to encoding the reader was configured with.
the read string. May be smaller than requested size. Empty when end of stream is reached.
-Reads an unsigned 16 bit value.
-Optional endianness. Defaults to endianness the reader was configured with.
-Reads an array of unsigned 16 bit values.
+Reads an unsigned 16 bit value.
+Optional endianness. Defaults to endianness the reader was configured with.
+Reads an array of unsigned 16 bit values.
The buffer to write the read bytes to.
-Optional read array option.
+Optional read array option.
the number of read 16 bit values. 0 when end of stream is reached or 0 bytes were requested to read.
-Reads an unsigned 32 bit value.
-Optional endianness. Defaults to endianness the reader was configured with.
-Reads an array of unsigned 32 bit values.
+Reads an unsigned 32 bit value.
+Optional endianness. Defaults to endianness the reader was configured with.
+Reads an array of unsigned 32 bit values.
The buffer to write the read bytes to.
-Optional read array option.
+Optional read array option.
the number of read 16 bit values. 0 when end of stream is reached or 0 bytes were requested to read.
-Reads and returns an unsigned 8 bit value.
+Reads an array of unsigned 8 bit values.
+Reads an array of unsigned 8 bit values.
The buffer to write the read bytes to.
Offset within the buffer to start writing to. Defaults to 0.
Number of bytes to read. Defaults to buffer size minus offset.
the number of read bytes. 0 when end of stream is reached or 0 bytes were requested to read.
-Skips the given number of bits. This is not the same as simply reading the given number of bits and ignoring +
Skips the given number of bits. This is not the same as simply reading the given number of bits and ignoring the read data. Instead it is optimized to first skip as many bits as needed to get to a byte boundary then skipping full bytes inside current buffer, optionally fetching new buffers and finally skipping the remaining number of bits.
The number of bits to skip.
The actual number of skipped bits. Will be lower than given number if end of stream has been reached.
-Skips the given number of bytes. This is not the same as simply reading the given number of bytes and ignoring +
Skips the given number of bytes. This is not the same as simply reading the given number of bytes and ignoring the read data. Instead it is optimized to first skip as many bits as needed to get to a byte boundary then skipping full bytes inside the current buffer, optionally fetching new buffers and finally skipping the remaining bits.
-Actually this is the same as calling skipBits with the number of bytes converted to the number of bits.
+Actually this is the same as calling skipBits with the number of bytes converted to the number of bits.
The number of bytes to skip.
The actual number of fully skipped bytes (not counting partially skipped bytes). Will be lower than - given number if end of stream has been reached.
-Generated using TypeDoc
Generated using TypeDoc
Writes all kind of data values to a specified sink.
+Writes all kind of data values to a specified sink.
Written data is buffered so you have to call the flush method when you are done writing all data to ensure that all data is written to the sink.
All methods of the writer are asynchronous but can safely be used synchronously when you have no reason to wait for it. Usually you only want to wait for the flush method at the end of a write operation.
-Creates a new data writer for writing data to the given sink.
-The sink to write data to.
-Creates a new data writer for writing data to the given sink.
+The sink to write data to.
+Returns the default endianness of the writer.
-the default endianness used when no endianness is specified as parameter to the various write methods.
+Returns the default endianness of the writer.
+the default endianness used when no endianness is specified as parameter to the various write methods.
Returns the number of written bytes. This value reflects the number of bytes the writer was told to write so far, not the actual number of written bytes (which may not be finished because writing happens asynchronously). When a write operation fails then this counter is invalid and may not be in sync with the output sink any @@ -44,30 +44,30 @@
the number of written bytes.
Writes an signed 64 bit value.
The value to write.
-Optional endianness. Defaults to endianness the writer was configured with.
+Optional endianness. Defaults to endianness the writer was configured with.
Writes an array of signed 64 bit values.
The values to write.
-Optional endianness. Defaults to endianness the writer was configured with.
+Optional endianness. Defaults to endianness the writer was configured with.
Writes an unsigned 64 bit value.
The value to write.
-Optional endianness. Defaults to endianness the writer was configured with.
+Optional endianness. Defaults to endianness the writer was configured with.
Writes an array of unsigned 64 bit values.
The values to write.
-Optional endianness. Defaults to endianness the writer was configured with.
+Optional endianness. Defaults to endianness the writer was configured with.
Writes a signed 16 bit value.
The value to write.
-Optional endianness. Defaults to endianness the writer was configured with.
+Optional endianness. Defaults to endianness the writer was configured with.
Writes an array of signed 16 bit values.
The values to write.
-Optional endianness. Defaults to endianness the writer was configured with.
+Optional endianness. Defaults to endianness the writer was configured with.
Writes a signed 32 bit value.
The value to write.
-Optional endianness. Defaults to endianness the writer was configured with.
+Optional endianness. Defaults to endianness the writer was configured with.
Writes an array of signed 32 bit values.
The values to write.
-Optional endianness. Defaults to endianness the writer was configured with.
+Optional endianness. Defaults to endianness the writer was configured with.
Writes an unsigned 16 bit value.
The value to write.
-Optional endianness. Defaults to endianness the writer was configured with.
+Optional endianness. Defaults to endianness the writer was configured with.
Writes an array of unsigned 16 bit values.
The values to write.
-Optional endianness. Defaults to endianness the writer was configured with.
+Optional endianness. Defaults to endianness the writer was configured with.
Writes an unsigned 32 bit value.
The value to write.
-Optional endianness. Defaults to endianness the writer was configured with.
+Optional endianness. Defaults to endianness the writer was configured with.
Writes an array of unsigned 32 bit values.
The values to write.
-Optional endianness. Defaults to endianness the writer was configured with.
+Optional endianness. Defaults to endianness the writer was configured with.
Writes an array of unsigned 8 bit values.
diff --git a/classes/core.Uint8ArraySink.html b/classes/core.Uint8ArraySink.html new file mode 100644 index 0000000..e3ac367 --- /dev/null +++ b/classes/core.Uint8ArraySink.html @@ -0,0 +1,25 @@ +Sink which writes into a growing Uint8Array.
+Creates a new Uint8Array sink with the given initial capacity.
+Generated using TypeDoc
Source which reads from a Uint8Array.
+Creates a new Uint8Array sink with the given initial capacity.
+Generated using TypeDoc
Sink which writes into a growing Uint8Array.
-Creates a new Uint8Array sink with the given initial capacity.
-Generated using TypeDoc
Source which reads from a Uint8Array.
-Creates a new Uint8Array sink with the given initial capacity.
-Generated using TypeDoc
File input stream for Node.js.
-Creates a new file input stream reading to the given file.
The name of the file to read.
The size of the chunks to read from the file.
-Generated using TypeDoc
Generated using TypeDoc
File output stream for Node.js.
-Creates a new file output stream writing to the given file.
The name of the file to write to.
-Generated using TypeDoc
Generated using TypeDoc
Enum for specifying endianness
-Generated using TypeDoc
Returns the native endianness of the system.
-the system's native endianness.
+Returns the native endianness of the system.
+the system's native endianness.
Generated using TypeDoc
Creates a data reader for the given stream, passes it to the given callback function and releases the stream reader +
Creates a data reader for the given stream, passes it to the given callback function and releases the stream reader lock after callback execution.
The stream to read from.
The callback function to call with the created data reader as argument.
-Optional options: DataReaderOptionsOptional data reader options.
-Generated using TypeDoc
Optional options: DataReaderOptionsOptional data reader options.
+Generated using TypeDoc
Swaps endianness of given 16 bit value.
+Generated using TypeDoc
Swaps endianness of given 32 bit value.
+Generated using TypeDoc
Swaps endianness of given 64 bit value.
+Generated using TypeDoc
Creates a data writer for the given stream, passes it to the given callback function, flushes the data writer +
Creates a data writer for the given stream, passes it to the given callback function, flushes the data writer and release the stream writer lock after callback execution.
The stream to write to.
The callback function to call with the created data writer as argument.
-Optional options: DataWriterOptionsOptional data writer options.
+Optional options: DataWriterOptionsOptional data writer options.
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Options for constructing a data reader.
-Options for constructing a data reader.
+Optional encodingThe encoding used to read strings. Defaults to "utf-8".
-Optional endiannessThe endianness to use for reading multi-byte values. Defaults to native endianness.
+Optional endiannessThe endianness to use for reading multi-byte values. Defaults to native endianness.
Generated using TypeDoc
Interface for a data reader source.
-Interface for a data reader source.
+Generated using TypeDoc
Options for constructing a data writer.
-Options for constructing a data writer.
+Optional bufferThe buffer size. Defaults to 64KB.
Optional encodingThe encoding used to write strings. Defaults to "utf-8".
-Optional endiannessThe endianness to use for writing multi-byte values. Defaults to native endianness.
+Optional endiannessThe endianness to use for writing multi-byte values. Defaults to native endianness.
Generated using TypeDoc
Interface for a data writer sink.
-Interface for a data writer sink.
+Writes the given chunk to the sink.
Chunk of data to write to the sink.
a promise if write operation is asynchronous, nothing when write operation is synchronous.
diff --git a/interfaces/index.ReadArrayOptions.html b/interfaces/core.ReadArrayOptions.html similarity index 74% rename from interfaces/index.ReadArrayOptions.html rename to interfaces/core.ReadArrayOptions.html index b151435..e5b1ed2 100644 --- a/interfaces/index.ReadArrayOptions.html +++ b/interfaces/core.ReadArrayOptions.html @@ -1,6 +1,6 @@ -Options for the various read array methods of a data reader.
-Options for the various read array methods of a data reader.
+Optional offsetOptional offset within the buffer to start writing to. Defaults to 0.
Optional sizeOptional number of bytes to read. Defaults to buffer size minus offset.
Generated using TypeDoc
Optional encodingThe text encoding. Defaults to encoding the reader was configured with.
+Optional includeEOLTrue to include EOL marker in returned line. Defaults to false.
+Optional initialThe initial buffer capacity for creating the string bytes. The buffer size duplicates itself when full, so the +higher this value is set the less buffer grows happen but the more memory is wasted for reading small lines. +Defaults to 1024.
+Optional maxThe maximum number of bytes (not characters!) to read. Default is unlimited.
+Generated using TypeDoc
Options for the various multi-byte read array methods of a data reader.
+Optional endiannessOptional endianness. Defaults to endianness the reader was configured with.
+Optional offsetOptional offset within the buffer to start writing to. Defaults to 0.
+Optional sizeOptional number of bytes to read. Defaults to buffer size minus offset.
+Generated using TypeDoc
Optional encodingThe text encoding. Defaults to encoding the reader was configured with.
Optional initialThe initial buffer capacity for creating the string bytes. The buffer size duplicates itself when full, so the higher this value is set the less buffer grows happen but the more memory is wasted for reading small lines. diff --git a/interfaces/index.ReadLineOptions.html b/interfaces/index.ReadLineOptions.html deleted file mode 100644 index 0fb6cf8..0000000 --- a/interfaces/index.ReadLineOptions.html +++ /dev/null @@ -1,11 +0,0 @@ -
Optional encodingThe text encoding. Defaults to encoding the reader was configured with.
-Optional includeEOLTrue to include EOL marker in returned line. Defaults to false.
-Optional initialThe initial buffer capacity for creating the string bytes. The buffer size duplicates itself when full, so the -higher this value is set the less buffer grows happen but the more memory is wasted for reading small lines. -Defaults to 1024.
-Optional maxThe maximum number of bytes (not characters!) to read. Default is unlimited.
-Generated using TypeDoc
Options for the various multi-byte read array methods of a data reader.
-Optional endiannessOptional endianness. Defaults to endianness the reader was configured with.
-Optional offsetOptional offset within the buffer to start writing to. Defaults to 0.
-Optional sizeOptional number of bytes to read. Defaults to buffer size minus offset.
-Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Reads all kind of data values from the specified source.
-