@jyostudio/io - v0.1.5
    正在准备搜索索引...

    类 MemoryStream

    创建一个流，其后备存储为内存。

    层级 (查看层级一览)

    索引

    构造函数

    constructor

    访问器

    canRead canSeek canTimeout canWrite capacity length position readTimeout writeTimeout null

    方法

    [dispose] close copyTo flush getBuffer read readAsync readByte seek setLength toArray write writeAsync writeByte writeTo

    构造函数

    • 使用初始化为零的可扩展容量初始化 MemoryStream 类的新实例。

      返回 MemoryStream

    • 使用按指定要求初始化的可扩展容量初始化 MemoryStream 类的新实例。

      参数

      • capacity: number

        内部数组的初始大小（以字节为单位）。

      返回 MemoryStream

    • 基于指定的字节数组初始化 MemoryStream 类的无法调整大小的新实例。

      参数

      • buffer: Uint8Array

        从中创建当前流的无符号字节数组。

      返回 MemoryStream

    • 在 MemoryStream.CanWrite 属性按指定设置的状态下，基于指定的字节数组初始化 MemoryStream 类的无法调整大小的新实例。

      参数

      • buffer: Uint8Array

        从中创建此流的无符号字节的数组。

      • writable: boolean

        MemoryStream.CanWrite 属性的设置，确定该流是否支持写入。

      返回 MemoryStream

    • 基于字节数组的指定区域（索引）初始化 MemoryStream 类的无法调整大小的新实例。

      参数

      • buffer: Uint8Array

        从中创建此流的无符号字节的数组。

      • index: number

        buffer 内的索引，流从此处开始。

      • count: number

        流的长度（以字节为单位）。

      返回 MemoryStream

    • 在 MemoryStream.CanWrite 属性按指定设置的状态下，基于字节数组的指定区域，初始化 MemoryStream 类的无法调整大小的新实例。

      参数

      • buffer: Uint8Array

        从中创建此流的无符号字节的数组。

      • index: number

        buffer 内的索引，流从此处开始。

      • count: number

        流的长度（以字节为单位）。

      • writable: boolean

        MemoryStream.CanWrite 属性的设置，确定该流是否支持写入。

      返回 MemoryStream

    • 在 MemoryStream.CanWrite 属性和调用 MemoryStream.GetBuffer 的能力按指定设置的状态下，基于字节数组的指定区域初始化 MemoryStream 类的新实例。

      参数

      • buffer: Uint8Array

        从中创建此流的无符号字节的数组。

      • index: number

        buffer 内的索引，流从此处开始。

      • count: number

        流的长度（以字节为单位）。

      • writable: boolean

        MemoryStream.CanWrite 属性的设置，确定该流是否支持写入。

      • publiclyVisible: boolean

        设置为 true 可以启用 MemoryStream.GetBuffer，它返回无符号字节数组，流从该数组创建；否则为 false。

      返回 MemoryStream

    访问器

    • get canRead(): boolean

      获取一个值，该值指示当前流是否支持读取。

      返回 boolean

      如果流是打开的，则为 true。

    • get canSeek(): boolean

      获取一个值，该值指示当前流是否支持查找。

      返回 boolean

      如果流是打开的，则为 true。

    • get canTimeout(): boolean

      当在派生类中重写时，获取指示当前流是否支持超时。

      返回 boolean

      如果流支持超时，为 true；否则为 false。

    • get canWrite(): boolean

      获取一个值，该值指示当前流是否支持写入。

      返回 boolean

      如果流支持写入，则为 true；否则为 false。

    • get capacity(): number

      获取分配给该流的字节数。

      返回 number

      流的缓冲区的可使用部分的长度。

    • set capacity(value: number): void

      设置分配给该流的字节数。

      参数

      • value: number

        分配给该流的字节数。

      返回 void

    • get length(): number

      获取流的长度（以字节为单位）。

      返回 number

      流的长度（以字节为单位）。

    • get position(): number

      获取流中的当前位置。

      返回 number

      流中的当前位置。

    • set position(value: number): void

      设置流中的当前位置。

      参数

      • value: number

        流中的当前位置。

      返回 void

    • get readTimeout(): number

      获取一个值（以毫秒为单位），该值确定流在超时前尝试读取多长时间。

      返回 number

      一个确定流在超时前尝试读取多长时间的值（以毫秒为单位）。

      如果当前流不支持读取超时。

    • set readTimeout(value: number): void

      设置一个值（以毫秒为单位），该值确定流在超时前尝试读取多长时间。

      参数

      • value: number

        一个确定流在超时前尝试读取多长时间的值（以毫秒为单位）。

      返回 void

      如果当前流不支持读取超时。

      如果 value 小于 0。

    • get writeTimeout(): number

      获取一个值（以毫秒为单位），该值确定流在超时前尝试写入多长时间。

      返回 number

      如果流支持写入超时，则为超时时间（以毫秒为单位）；否则为 0。

      如果当前流不支持写入超时。

    • set writeTimeout(value: number): void

      设置一个值（以毫秒为单位），该值确定流在超时前尝试写入多长时间。

      参数

      • value: number

        一个确定流在超时前尝试写入多长时间的值（以毫秒为单位）。

      返回 void

      如果当前流不支持写入超时。

      如果 value 小于 0。

    方法

    • 从当前流中读取字节并将其写入到另一流中。

      参数

      • destination: Stream

        当前流的内容将复制到的流。

      返回 void

      如果流已关闭，或者目标流已关闭，或者当前流不支持读取操作，或者目标流不支持写入操作。

    • 使用指定的缓冲区大小，从当前流中读取字节并将其写入到另一流中。

      参数

      • destination: Stream

        当前流的内容将复制到的流。

      • bufferSize: number

        缓冲区的大小。 此值必须大于零。 默认大小为 81920。

      返回 void

      如果流已关闭，或者目标流已关闭，或者当前流不支持读取操作，或者目标流不支持写入操作。

      如果缓冲区大小小于等于 0。

    • 返回从中创建此流的无符号字节的数组。

      返回 Uint8Array

      创建此流所用的字节数组；或者如果在当前实例的构造期间没有向 MemoryStream 构造函数提供字节数组，则为基础数组。

    • 从当前流中读取字节块并将数据写入缓冲区。

      参数

      • buffer: Uint8Array

        当此方法返回时，包含指定的字节数组，该数组中从 offset 到 (offset + count -1) 之间的值由从当前流中读取的字符替换。

      • offset: number

        buffer 中的从零开始的字节偏移量，从此处开始存储当前流中的数据。

      • count: number

        最多读取的字节数。

      返回 number

      写入缓冲区中的总字节数。 如果字节数当前不可用，则总字节数可能小于所请求的字节数；如果在读取到任何字节前已到达流结尾，则为零。

    • 异步读取当前流中的字节。

      参数

      • buffer: Uint8Array

        要读取的字节将存储在此缓冲区中。

      • offset: number

        缓冲区中的从零开始的字节偏移量，从此处开始存储从当前流中读取的数据。

      • count: number

        要从当前流中最多读取的字节数。

      返回 Promise<any>

      返回一个 Promise，该 Promise 在读取完成时解析为读取的字节数，或者在发生错误时解析为错误对象。

    • 从当前流中读取一个字节。

      返回 number

      强制转换为 Int32 的字节；或者如果已到达流的末尾，则为 -1。

    • 将当前流中的位置设置为指定值。

      参数

      • offset: number

        流内的新位置。 它是相对于 loc 参数的位置，而且可正可负。

      • loc: SeekOrigin

        类型 SeekOrigin 的值，它用作查找引用点。

      返回 number

      流内的新位置，通过将初始引用点和偏移量合并计算而得。

    • 将流内容写入字节数组，而与 MemoryStream.position 属性无关。

      返回 number[]

      新的字节数组。

    • 使用从缓冲区读取的数据将字节块写入当前流。

      参数

      • buffer: Uint8Array

        从中写入数据的缓冲区。

      • offset: number

        buffer 中的从零开始的字节偏移量，从此处开始将字节复制到当前流。

      • count: number

        最多写入的字节数。

      返回 void

    • 异步将字节写入当前流。

      参数

      • buffer: Uint8Array

        要写入的字节。

      • offset: number

        缓冲区中的从零开始的字节偏移量，从此处开始将字节写入当前流。

      • count: number

        要写入当前流的字节数。

      返回 Promise<any>

      返回一个 Promise，该 Promise 在写入完成时解析为写入的字节数，或者在发生错误时解析为错误对象。

    • 将此内存流的整个内容写入到另一个流中。

      参数

      • stream: Stream

        要写入此内存流的流。

      返回 void

    显示设置

    成员可见性

    目录

    构造函数
    访问器
    方法