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

使用已安装 RmlUi 文件接口的只读 Rml::StreamFile。

shutdown 前自动关闭。close 后须重新打开才能 read、seek 和 tell。 内存修改操作始终抛出异常。

继承关系

层级 (查看层级一览)

源码与继承
成员目录21

构造函数

方法

构造函数

方法

  • 调用 Rml::Stream::Close;内存字节保留至 shutdown。

    返回值

    void
    源码与继承
  • 将 Rml::Stream::GetSourceURL 作为文本返回。

    返回值

    string

    相对资源使用的来源 URL。

    源码与继承
  • 返回 Rml::Stream::GetStreamMode;新内存流初始为零。

    返回值

    number

    原生模式位掩码。

    源码与继承
  • 调用 Rml::Stream::IsEOS。

    返回值

    boolean

    游标是否位于末尾。

    源码与继承
  • 检查就绪状态;不可变内存快照和文件始终返回 false。

    返回值

    boolean

    当前是否可写入字节。

    源码与继承
  • 打开文件,先释放之前的原生文件句柄。

    参数

    path
    string

    文件接口路径;拒绝内嵌空字符。

    返回值

    boolean

    原生打开结果。

    源码与继承
  • 通过 Rml::Stream::Peek 读取,不推进游标。

    参数

    target
    number

    最大字节数。

    返回值

    Uint8Array

    不消耗来源的独立字节。

    源码与继承
  • 读取到视图,不推进游标。

    参数

    target
    Uint8Array

    目标字节视图。

    count可选
    number

    字节上限,默认为视图大小。

    返回值

    number

    复制且不消耗来源的字节数。

    源码与继承
  • 使用长度限制的计数安全调用 Rml::Stream::PopBack。

    参数

    count
    number

    最大删除字节数。

    返回值

    number

    实际删除字节数。

    源码与继承
  • 删除头部字节;过大计数限制为流长度。

    参数

    count
    number

    最大删除字节数。

    返回值

    number

    实际删除数;内存游标回退并限制在零及以上。

    源码与继承
  • 调用 Rml::Stream::PushBack 并恢复先前游标。

    参数

    input
    string | Uint8Array

    待追加的 UTF-8 文本或字节。

    返回值

    number

    追加字节数。

    源码与继承
  • 调用 Rml::Stream::PushFront;内存游标随插入推进。

    参数

    input
    string | Uint8Array

    待前插的 UTF-8 文本或字节。

    返回值

    number

    前插字节数。

    源码与继承
  • 通过 Rml::Stream::Read 读取字节。

    参数

    target
    number

    最大字节数。

    返回值

    Uint8Array

    从当前游标读取的独立字节。

    流复制保留原生计数,即使目标写入较少字节。禁止复制到自身。

    源码与继承
  • 通过 Rml::Stream::Read 读取到视图或流。

    参数

    target
    Uint8Array | Stream

    目标视图或流。

    count可选
    number

    字节上限,默认为视图大小或剩余长度。

    返回值

    number

    消耗的来源字节数,即使目标写入较少字节。

    源码与继承
  • 解码读取的 UTF-8 字节并追加至初始字符串。

    参数

    count
    number

    最大字节数。

    initial
    string = ''

    初始字符串,默认为空。

    返回值

    string

    追加后的字符串,保留内嵌空字符。

    源码与继承
  • 使用受检查的有符号整数偏移调用 Rml::Stream::Seek。

    参数

    offset
    number

    字节偏移;StreamMemory 的 End 减去此值。

    origin
    SeekOrigin = SeekOrigin.Set

    定位基准,默认为 Set。

    返回值

    boolean

    原生成功标记;无效内存目标保留原游标。

    源码与继承
  • 返回 Rml::Stream::Tell 字节位置。

    返回值

    number

    当前字节位置。

    源码与继承
  • 调用 Rml::Stream::Truncate;内存游标移动到新末尾。

    参数

    length
    number

    请求字节长度;大于现有内存长度时不作修改。

    返回值

    number

    删除字节数。

    源码与继承
  • 使用 UTF-8、字节或另一流调用 Rml::Stream::Write。

    参数

    input
    string | Uint8Array | Stream

    来源;字符串保留内嵌空字符。

    count可选
    number

    可选字节上限,默认为输入大小或剩余大小。

    返回值

    number

    写入字节数;复制流时为消耗的来源字节数。

    源码与继承
  • 使用原生 C 字符串写入语义,在首个空字符处停止。

    参数

    input
    string

    UTF-8 文本。

    返回值

    number

    首个空字符前写入的字节数。

    源码与继承

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