メソッドの概要

返却値の型 メソッド名
Number available ()
この入力ストリームのメソッドの次の呼び出しによって、ブロックせずにこの入力ストリームから読み込むことができる (またはスキップできる) 推定バイト数を返します。
Boolean close ()
ストリームを閉じて、それに関連するすべてのシステムリソースを解放します。
Boolean eachByte (Function callback)
1 バイトずつ読み込み、callback を呼び出します。callback には読み出されたバイトと、そのインデックス(先頭からのバイト数)が渡されます。
Boolean eachBytes (Function callback, Number transSize)
transSize バイトずつ読み込み、callback を呼び出します。callback には読み出されたバイト配列と、そのインデックス(先頭からのバイト数)と、読み出されたバイト数が渡されます。
Boolean markSupported ()
入力ストリームが mark と reset メソッドをサポートしているかどうかを判定します。
Boolean mark (Number readlimit)
この入力ストリームの現在位置にマークを設定します。
Number read (Number[] [b], Number [off], Number [len])
入力ストリームからオフセット off から len バイトまでのデータをバッファ配列 b に読み込みます。
Number reset ()
このストリームの位置を、入力ストリームで最後に mark メソッドが呼び出されたときのマーク位置に再設定します。
Number skip (Number n)
入力ストリームからのデータを n バイトだけスキップしてその範囲のデータを破棄します。
Boolean transferTo (ByteWriter writer, Number [transSize])
自身のストリームから読み込んだデータをすべて writer に書き込みます。

メソッドの詳細

Number available ()
この入力ストリームのメソッドの次の呼び出しによって、ブロックせずにこの入力ストリームから読み込むことができる (またはスキップできる) 推定バイト数を返します。
返却値
Number
Number 読み込み可能な推定バイト数(失敗した場合は null。)
Boolean close ()
ストリームを閉じて、それに関連するすべてのシステムリソースを解放します。
返却値
Boolean
Boolean 失敗した場合は false。
Boolean eachByte (Function callback)
1 バイトずつ読み込み、callback を呼び出します。callback には読み出されたバイトと、そのインデックス(先頭からのバイト数)が渡されます。
例:関数を渡せるので以下のような使い方をすることができます。
 reader.eachByte(function(element, index) {
   // 1バイト読み込まれるごとに呼ばれます.
 });
 
パラメータ
callback : Function
コールバック関数
返却値
Boolean
Boolean 失敗した場合は false。
Boolean eachBytes (Function callback, Number transSize)
transSize バイトずつ読み込み、callback を呼び出します。callback には読み出されたバイト配列と、そのインデックス(先頭からのバイト数)と、読み出されたバイト数が渡されます。
例:関数を渡せるので以下のような使い方をすることができます。
 reader.eachBytes(function(elements, index, size) {
   // transSizeバイト読み込まれるごとに呼ばれます.
 }, transSize);
 
パラメータ
callback : Function
コールバック関数
transSize : Number
転送させたいサイズ
返却値
Boolean
Boolean 失敗した場合は false。
Boolean markSupported ()
入力ストリームが mark と reset メソッドをサポートしているかどうかを判定します。
返却値
Boolean
Boolean このストリームインスタンスが mark および reset メソッドをサポートしている場合は true、サポートしていない場合は false。失敗した場合は null。
Boolean mark (Number readlimit)
この入力ストリームの現在位置にマークを設定します。
パラメータ
readlimit : Number
入力ストリームの現在位置
返却値
Boolean
Boolean 失敗した場合は false。
Number read (Number[] [b], Number [off], Number [len])
入力ストリームからオフセット off から len バイトまでのデータをバッファ配列 b に読み込みます。
オフセット off と 読み込むバイト数 len が省略された場合は入力ストリームからバイト数を読み込み、それをバッファ配列 b に格納します。
更にバッファ配列 bも省略された場合は入力ストリームから次のバイトデータを読み込みます。
パラメータ
[b] : Number[]
入力ストリーム
[off] : Number
オフセット
[len] : Number
読み込むバイト数
返却値
Number
Number バッファに読み込まれたバイトの合計数。(バッファ配列省略時はデータの次のバイト。)ストリームの終わりに達してデータがない場合は -1。失敗した場合は null。
Number reset ()
このストリームの位置を、入力ストリームで最後に mark メソッドが呼び出されたときのマーク位置に再設定します。
返却値
Number
Number 失敗した場合は -1。失敗した場合は false。
Number skip (Number n)
入力ストリームからのデータを n バイトだけスキップしてその範囲のデータを破棄します。
パラメータ
n : Number
スキップするバイト数
返却値
Number
Number 実際にスキップされたバイト数。失敗した場合は -1。失敗した場合は null。
Boolean transferTo (ByteWriter writer, Number [transSize])
自身のストリームから読み込んだデータをすべて writer に書き込みます。
transSize が指定されている場合、tranSize バイト毎転送を行います。transSize が大きいほど高速ですが、その分メモリを消費します。
パラメータ
writer : ByteWriter
書き込み先
[transSize] : Number
転送させたいバイト数
返却値
Boolean
Boolean 失敗した場合は false。