API 参考
正在准备搜索索引…

StreamCallbacks

Rml::Stream 虚方法的同步实现。

方法仅捕获一次。read 和 peek 接收独立临时数组,写入接收快照。 必须返回准确计数或布尔值,不能返回 Promise。禁止重入原生 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

可选不推进游标的读取;默认读取后通过 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] 范围内的整数。

源码与继承

方法

  • 可选显式关闭回调;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