API リファレンス
検索インデックスを準備中…

StreamCallbacks

Rml::Stream 仮想メソッドの同期実装。

メソッドは一度取得します。read と peek は独立配列、write は コピーを受け取ります。正確な数値か真偽値を同期で返してください。 ネイティブ API の再入は禁止です。循環参照も GC が回収できます。

interface StreamCallbacks {
    peek?: (output: Uint8Array, count: number) => number;
    popBack?: (length: number) => number;
    popFront?: (length: number) => number;
    pushBack?: (input: Uint8Array, count: number) => number;
    pushFront?: (input: Uint8Array, count: number) => number;
    close(): void;
    isEOS(): boolean;
    isReadReady(): boolean;
    isWriteReady(): boolean;
    length(): number;
    read(output: Uint8Array, count: number): number;
    seek(offset: number, origin: SeekOrigin): boolean;
    tell(): number;
    truncate(length: number): number;
    write(input: Uint8Array, count: number): number;
}
ソースと継承
メンバー一覧15

プロパティ

メソッド

プロパティ

peek?: (output: Uint8Array, count: number) => number

位置を進めない任意の読み取り。既定は read 後に seek で戻します。

型宣言

    • (output: Uint8Array, count: number): number
    • 独立した一時領域に読み込み、カーソルを進めます。

      引数

      output
      Uint8Array

      一時バイト列。バッファの切り離しやサイズ変更は禁止です。

      count
      number

      最大読み取りバイト数。

      戻り値

      number

      [0, count] の整数。

ソースと継承
popBack?: (length: number) => number

任意の末尾削除。既定は truncate() です。

型宣言

    • (length: number): number
    • 長さを縮小し、削除したバイト数を返します。

      引数

      length
      number

      要求するバイト長。

      戻り値

      number

      削除したバイト数を非負の安全な整数で返します。

ソースと継承
popFront?: (length: number) => number

任意の先頭削除。未実装の場合は例外です。

型宣言

    • (length: number): number
    • 長さを縮小し、削除したバイト数を返します。

      引数

      length
      number

      要求するバイト長。

      戻り値

      number

      削除したバイト数を非負の安全な整数で返します。

ソースと継承
pushBack?: (input: Uint8Array, count: number) => number

任意の追記。既定はシーク、書き込み、位置の復元です。

型宣言

    • (input: Uint8Array, count: number): number
    • 渡された独立バイトコピーを書き込みます。

      引数

      input
      Uint8Array

      独立したコピー。変更は呼び出し元に影響しません。

      count
      number

      最大書き込みバイト数。

      戻り値

      number

      [0, count] の整数。

ソースと継承
pushFront?: (input: Uint8Array, count: number) => number

任意の先頭挿入。未実装の場合は例外です。

型宣言

    • (input: Uint8Array, count: number): number
    • 渡された独立バイトコピーを書き込みます。

      引数

      input
      Uint8Array

      独立したコピー。変更は呼び出し元に影響しません。

      count
      number

      最大書き込みバイト数。

      戻り値

      number

      [0, count] の整数。

ソースと継承

メソッド

  • 明示的 close の任意コールバック。GC や shutdown は呼びません。

    戻り値

    void
    ソースと継承
  • 任意の EOF 判定。既定は tell() が length() 以上かどうかです。

    戻り値

    boolean

    ストリーム終了状態。

    ソースと継承
  • 読み取りの準備ができているかを返します。

    戻り値

    boolean

    読み取りの準備状態。

    ソースと継承
  • 現在書き込みが可能かを返します。

    戻り値

    boolean

    書き込みの準備状態。

    ソースと継承
  • 総バイト長を非負の安全な整数で返します。

    戻り値

    number

    総バイト長。

    ソースと継承
  • 独立した一時領域に読み込み、カーソルを進めます。

    引数

    output
    Uint8Array

    一時バイト列。バッファの切り離しやサイズ変更は禁止です。

    count
    number

    最大読み取りバイト数。

    戻り値

    number

    [0, count] の整数。

    ソースと継承
  • ネイティブのシーク。末尾オフセットの規則は実装が決めます。

    引数

    offset
    number

    符号付きバイトオフセット。

    origin

    ネイティブのシーク基準。

    戻り値

    boolean

    カーソルの移動に成功したか。

    ソースと継承
  • 現在のバイト位置を非負の安全な整数で返します。

    戻り値

    number

    現在のバイト位置。

    ソースと継承
  • 長さを縮小し、削除したバイト数を返します。

    引数

    length
    number

    要求するバイト長。

    戻り値

    number

    削除したバイト数を非負の安全な整数で返します。

    ソースと継承
  • 渡された独立バイトコピーを書き込みます。

    引数

    input
    Uint8Array

    独立したコピー。変更は呼び出し元に影響しません。

    count
    number

    最大書き込みバイト数。

    戻り値

    number

    [0, count] の整数。

    ソースと継承

Icons made by Lorc, Delapouite & Skoll · game-icons.net · CC BY 3.0