# @ohos.fastbuffer (FastBuffer)
FastBuffer对象是更高效的Buffer容器,用于表示固定长度的字节序列,是专门存放二进制数据的缓存区。
FastBuffer通过from构造时,仅支持FastBuffer、Uint8Array、string、Array、ArrayBuffer类型的参数。
需要高性能处理大型二进制数据(如图片、文件传输、网络通信等)时,推荐使用FastBuffer。
> **说明:**
>
> 本模块首批接口从API version 20开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
> 容器类使用静态语言实现,限制了存储位置和属性,不支持自定义属性和方法。
## 导入模块
```ts
import { fastbuffer } from '@kit.ArkTS';
```
## BufferEncoding
type BufferEncoding = 'ascii' | 'utf8' | 'utf-8' | 'utf16le' | 'ucs2' | 'ucs-2' | 'base64' | 'base64url' | 'latin1' | 'binary' | 'hex'
表示支持的编码格式类型。
**原子化服务API**:从API version 20开始,该接口支持在原子化服务中使用。
**系统能力:** SystemCapability.Utils.Lang
| 类型 | 说明 |
| ------- | -------------------- |
| 'ascii' | 表示ascii格式。 |
| 'utf8' | 表示utf8格式。 |
| 'utf-8' | 表示utf8格式。 |
| 'utf16le' | 表示utf16小端序格式。 |
| 'ucs2' | utf16le格式的别名。 |
| 'ucs-2' | utf16le格式的别名。 |
| 'base64' | 表示base64格式。 |
| 'base64url' | 表示base64url格式。 |
| 'latin1' | iso-8859-1的别名,向下兼容ascii格式。 |
| 'binary' | 表示二进制格式。 |
| 'hex' | 表示十六进制格式。 |
## fastbuffer.alloc
alloc(size: number, fill?: string | FastBuffer | number, encoding?: BufferEncoding): FastBuffer
创建指定字节长度的FastBuffer对象并初始化。
**原子化服务API**:从API version 20开始,该接口支持在原子化服务中使用。
**系统能力:** SystemCapability.Utils.Lang
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| size | number | 是 | 指定的FastBuffer对象长度,单位:字节。取值范围:0 <= size <= UINT32_MAX。|
| fill | string \| FastBuffer \| number | 否 | 填充至新缓存区的值,默认值:0。 |
| encoding | [BufferEncoding](#bufferencoding) | 否 | 编码格式(当`fill`为string时,才有意义)。默认值:'utf8'。传入无法识别的encoding会抛出TypeError。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| [FastBuffer](#fastbuffer) | 返回一个FastBuffer对象。 |
**示例:**
```ts
import { fastbuffer } from '@kit.ArkTS';
let buf1 = fastbuffer.alloc(5);
let buf2 = fastbuffer.alloc(5, 'a');
let buf3 = fastbuffer.alloc(11, 'aGVsbG8gd29ybGQ=', 'base64');
console.info(buf2.toString());
// 输出结果:aaaaa
console.info(buf3.toString());
// 输出结果:hello world
```
## fastbuffer.allocUninitializedFromPool
allocUninitializedFromPool(size: number): FastBuffer
从缓冲池中创建指定大小未初始化的FastBuffer对象,需要使用[fill](#fill)函数来初始化FastBuffer对象。
**原子化服务API**:从API version 20开始,该接口支持在原子化服务中使用。
**系统能力:** SystemCapability.Utils.Lang
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| size | number | 是 | 指定的FastBuffer对象长度,单位:字节。取值范围:0 <= size <= UINT32_MAX。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| [FastBuffer](#fastbuffer) | 未初始化的Buffer实例。 |
**示例:**
```ts
import { fastbuffer } from '@kit.ArkTS';
let buf = fastbuffer.allocUninitializedFromPool(10);
buf.fill(0);
// "buf":[0, 0, 0, 0, 0, 0, 0, 0, 0, 0]
```
## fastbuffer.allocUninitialized
allocUninitialized(size: number): FastBuffer
创建指定大小未初始化的FastBuffer对象,需要使用[fill](#fill)函数来初始化FastBuffer对象。
**原子化服务API**:从API version 20开始,该接口支持在原子化服务中使用。
**系统能力:** SystemCapability.Utils.Lang
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| size | number | 是 |指定的FastBuffer对象长度,单位:字节。取值范围:0 <= size <= UINT32_MAX。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| [FastBuffer](#fastbuffer) | 未初始化的FastBuffer实例。 |
**示例:**
```ts
import { fastbuffer } from '@kit.ArkTS';
let buf = fastbuffer.allocUninitialized(10);
buf.fill(0);
// "buf":[0, 0, 0, 0, 0, 0, 0, 0, 0, 0]
```
## fastbuffer.byteLength
byteLength(value: string | FastBuffer | TypedArray | DataView | ArrayBuffer | SharedArrayBuffer, encoding?: BufferEncoding): number
根据不同的编码格式,返回指定字符串的字节数。
**原子化服务API**:从API version 20开始,该接口支持在原子化服务中使用。
**系统能力:** SystemCapability.Utils.Lang
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| value | string \| FastBuffer \| TypedArray \| DataView \| ArrayBuffer \| SharedArrayBuffer | 是 | 指定字符串。 |
| encoding | [BufferEncoding](#bufferencoding) | 否 | 编码格式。默认值:'utf8'。传入无法识别的encoding会抛出TypeError。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| number | 返回指定字符串的字节数。 |
**示例:**
```ts
import { fastbuffer } from '@kit.ArkTS';
let str = 'hello world';
console.info(`${str}: ${str.length} characters, ${fastbuffer.byteLength(str, 'utf-8')} bytes`);
// 输出结果:hello world: 11 characters, 11 bytes
str = '\u00bd + \u00bc = \u00be';
console.info(`${str}: ${str.length} characters, ${fastbuffer.byteLength(str, 'utf-8')} bytes`);
// 输出结果:½ + ¼ = ¾: 9 characters, 12 bytes
```
## fastbuffer.compare
compare(buf1: FastBuffer | Uint8Array, buf2: FastBuffer | Uint8Array): -1 | 0 | 1
返回两个FastBuffer对象的比较结果,通常用于对FastBuffer对象数组进行排序。
**原子化服务API**:从API version 20开始,该接口支持在原子化服务中使用。
**系统能力:** SystemCapability.Utils.Lang
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| buf1 | [FastBuffer](#fastbuffer) \| Uint8Array | 是 | 待比较的第一个对象。 |
| buf2 | [FastBuffer](#fastbuffer) \| Uint8Array | 是 | 待比较的第二个对象。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| -1 \| 0 \| 1 | 如果buf1与buf2相同,则返回0。
如果排序时buf1位于buf2之后,则返回1。
如果排序时buf1位于buf2之前,则返回-1。 |
**错误码:**
以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 10200068 | The underlying ArrayBuffer is null or detach. |
**示例:**
```ts
import { fastbuffer } from '@kit.ArkTS';
let buf1 = fastbuffer.from('1234');
let buf2 = fastbuffer.from('0123');
let res = fastbuffer.compare(buf1, buf2);
console.info(Number(res).toString());
// 输出结果:1
```
## fastbuffer.concat
concat(list: FastBuffer[] | Uint8Array[], totalLength?: number): FastBuffer
将数组中指定字节长度的内容复制到新的FastBuffer对象中并返回拼接后的FastBuffer对象。
当数组中所有对象的长度总和大于totalLength时,返回结果的长度将被截断为totalLength。
当数组中所有对象的长度总和小于totalLength时,返回结果的多余部分将会被填充为0。
**系统能力:** SystemCapability.Utils.Lang
**原子化服务API**:从API version 20开始,该接口支持在原子化服务中使用。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| list | [FastBuffer](#fastbuffer)[] \| Uint8Array[] | 是 | 实例数组。 |
| totalLength | number | 否 | 需要复制的总字节长度,默认值为0。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| [FastBuffer](#fastbuffer) | 返回新的FastBuffer对象。 |
**错误码:**
以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[语言基础类库错误码](errorcode-utils.md)。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 10200001 | Range error. Possible causes: The value of the parameter is not within the specified range. |
**示例:**
```ts
import { fastbuffer } from '@kit.ArkTS';
let buf1 = fastbuffer.from("1234");
let buf2 = fastbuffer.from("abcd");
let buf = fastbuffer.concat([buf1, buf2]);
console.info(buf.toString('hex'));
// 输出结果:3132333461626364
```
## fastbuffer.from
from(array: number[]): FastBuffer
根据指定数组创建新的FastBuffer对象。
**系统能力:** SystemCapability.Utils.Lang
**原子化服务API**:从API version 20开始,该接口支持在原子化服务中使用。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| array | number[] | 是 | 指定数组。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| [FastBuffer](#fastbuffer) | 新的FastBuffer对象。 |
**示例:**
```ts
import { fastbuffer } from '@kit.ArkTS';
let buf = fastbuffer.from([0x62, 0x75, 0x66, 0x66, 0x65, 0x72]);
console.info(buf.toString('hex'));
// 输出结果:627566666572
```
## fastbuffer.from
from(arrayBuffer: ArrayBuffer | SharedArrayBuffer, byteOffset?: number, length?: number): FastBuffer
创建与`arrayBuffer`共享内存的指定长度的FastBuffer对象。
**原子化服务API**:从API version 20开始,该接口支持在原子化服务中使用。
**系统能力:** SystemCapability.Utils.Lang
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| arrayBuffer | ArrayBuffer \| SharedArrayBuffer | 是 | 实例对象。 |
| byteOffset | number | 否 | 字节偏移量,默认值:0。 |
| length | number | 否 | 字节长度, 默认值:(arrayBuffer.byteLength - byteOffset)。取值范围:0 <= length <= arrayBuffer.byteLength - byteOffset |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| [FastBuffer](#fastbuffer) | 返回一个FastBuffer对象,该对象与入参对象`arrayBuffer`共享相同的内存区域。 |
**错误码:**
以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[语言基础类库错误码](errorcode-utils.md)。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 10200001 | Range error. Possible causes: The value of the parameter is not within the specified range. |
| 10200068 | The underlying ArrayBuffer is null or detach. |
**示例:**
```ts
import { fastbuffer } from '@kit.ArkTS';
let ab = new ArrayBuffer(10);
let buf = fastbuffer.from(ab, 0, 2);
console.info(buf.length.toString());
// 输出结果:2
```
## fastbuffer.from
from(buffer: FastBuffer | Uint8Array): FastBuffer
当入参为FastBuffer对象时,创建新的FastBuffer对象并复制入参FastBuffer对象的数据,然后返回新对象。
当入参为Uint8Array对象时,基于Uint8Array对象的内存创建新的FastBuffer对象并返回,保持数据的内存关联。
**原子化服务API**:从API version 20开始,该接口支持在原子化服务中使用。
**系统能力:** SystemCapability.Utils.Lang
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| buffer | [FastBuffer](#fastbuffer) \| Uint8Array | 是 | 对象数据。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| [FastBuffer](#fastbuffer) | 返回新的FastBuffer对象。 |
**错误码:**
以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 10200068 | The underlying ArrayBuffer is null or detach. |
**示例:**
```ts
import { fastbuffer } from '@kit.ArkTS';
// 以FastBuffer对象类型进行创建新的FastBuffer对象
let buf1 = fastbuffer.from('buffer');
let buf2 = fastbuffer.from(buf1);
console.info(buf2.toString());
// 输出结果:buffer
// 以Uint8Array对象类型进行创建FastBuffer对象,保持对象间内存共享
let uint8Array = new Uint8Array(10);
let buf3 = fastbuffer.from(uint8Array);
buf3.fill(1)
console.info("uint8Array:", uint8Array)
// 输出结果:1,1,1,1,1,1,1,1,1,1
```
## fastbuffer.from
from(value: string, encoding?: BufferEncoding): FastBuffer
根据指定编码格式的字符串,创建新的FastBuffer对象。
**原子化服务API**:从API version 20开始,该接口支持在原子化服务中使用。
**系统能力:** SystemCapability.Utils.Lang
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| value | string | 是 | 字符串。 |
| encoding | [BufferEncoding](#bufferencoding) | 否 | 编码格式。默认值:'utf8'。传入无法识别的encoding会抛出TypeError。|
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| [FastBuffer](#fastbuffer) | 返回新的FastBuffer对象。 |
**示例:**
```ts
import { fastbuffer } from '@kit.ArkTS';
let buf1 = fastbuffer.from('this is a test');
let buf2 = fastbuffer.from('7468697320697320612074c3a97374', 'hex');
console.info(buf1.toString());
// 输出结果:this is a test
console.info(buf2.toString());
// 输出结果:this is a tést
```
## fastbuffer.isBuffer
isBuffer(obj: Object): boolean
判断`obj`是否为FastBuffer。
**原子化服务API**:从API version 20开始,该接口支持在原子化服务中使用。
**系统能力:** SystemCapability.Utils.Lang
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| obj | Object | 是 | 判断对象。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| boolean | 如果obj是FastBuffer,则返回true,否则返回false。 |
**示例:**
```ts
import { fastbuffer } from '@kit.ArkTS';
let result = fastbuffer.isBuffer(fastbuffer.alloc(10)); // 10: fastbuffer size
console.info("result = " + result);
// 输出结果:result = true
let result1 = fastbuffer.isBuffer(fastbuffer.from('foo'));
console.info("result1 = " + result1);
// 输出结果:result1 = true
let result2 = fastbuffer.isBuffer('a string');
console.info("result2 = " + result2);
// 输出结果:result2 = false
let result3 = fastbuffer.isBuffer([]);
console.info("result3 = " + result3);
// 输出结果:result3 = false
let result4 = fastbuffer.isBuffer(new Uint8Array(1024));
console.info("result4 = " + result4);
// 输出结果:result4 = false
```
## fastbuffer.isEncoding
isEncoding(encoding: string): boolean
判断`encoding`是否为支持的编码格式。
**原子化服务API**:从API version 20开始,该接口支持在原子化服务中使用。
**系统能力:** SystemCapability.Utils.Lang
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| encoding | string | 是 | 编码格式。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| boolean | 是支持的编码格式返回true,反之则返回false。 |
**示例:**
```ts
import { fastbuffer } from '@kit.ArkTS';
console.info(fastbuffer.isEncoding('utf-8').toString());
// 输出结果:true
console.info(fastbuffer.isEncoding('hex').toString());
// 输出结果:true
console.info(fastbuffer.isEncoding('utf/8').toString());
// 输出结果:false
console.info(fastbuffer.isEncoding('').toString());
// 输出结果:false
```
## fastbuffer.transcode
transcode(source: FastBuffer | Uint8Array, fromEnc: string, toEnc: string): FastBuffer
将FastBuffer或Uint8Array对象从fromEnc编码转换为toEnc编码。
fastbuffer.transcode支持的编码:'ascii' | 'utf8' | 'utf16le'| 'ucs2' | 'latin1'| 'binary'。
**系统能力:** SystemCapability.Utils.Lang
**原子化服务API**:从API version 20开始,该接口支持在原子化服务中使用。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| source | [FastBuffer](#fastbuffer) \| Uint8Array | 是 | 实例对象。 |
| fromEnc | string | 是 | 当前编码。 支持的格式范围为[BufferEncoding](#bufferencoding)。 |
| toEnc | string | 是 | 目标编码。 支持的格式范围为[BufferEncoding](#bufferencoding)。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| [FastBuffer](#fastbuffer) | 将当前编码转换成目标编码,并返回一个新的FastBuffer对象。 |
**示例:**
```ts
import { fastbuffer } from '@kit.ArkTS';
let newBuf = fastbuffer.transcode(fastbuffer.from('buffer'), 'utf-8', 'ascii');
console.info("newBuf = " + newBuf.toString('ascii'));
// 输出结果:newBuf = buffer
```
## FastBuffer
### 属性
**系统能力:** SystemCapability.Utils.Lang
**原子化服务API**:从API version 20开始,该接口支持在原子化服务中使用。
| 名称 | 类型 | 只读 | 可选 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| length | number | 是 | 否 | FastBuffer对象的字节长度。 |
| buffer | ArrayBuffer | 是 | 否 | ArrayBuffer对象。 |
| byteOffset | number | 是 | 否 | 当前Buffer所在内存池的偏移量。 |
**示例:**
```ts
import { fastbuffer } from '@kit.ArkTS';
let buf = fastbuffer.from("1236");
console.info(JSON.stringify(buf.length));
// 输出结果:4
let arrayBuffer = buf.buffer;
console.info(JSON.stringify(new Uint8Array(arrayBuffer)));
// 输出结果:{"0":49,"1":50,"2":51,"3":54}
console.info(JSON.stringify(buf.byteOffset));
// 输出结果:0
```
### compare
compare(target: FastBuffer | Uint8Array, targetStart?: number, targetEnd?: number, sourceStart?: number, sourceEnd?: number): -1 | 0 | 1
比较当前对象this与目标对象target,并返回比较结果。
**原子化服务API**:从API version 20开始,该接口支持在原子化服务中使用。
**系统能力:** SystemCapability.Utils.Lang
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| target | [FastBuffer](#fastbuffer) \| Uint8Array | 是 | 要比较的实例对象。 |
| targetStart | number | 否 | `target`实例中开始的偏移量。默认值:0。 0 <= targetStart <= target.length。|
| targetEnd | number | 否 | `target`实例中结束的偏移量(不包含结束位置)。默认值:目标对象的字节长度。取值范围:0 <= targetEnd <= target.length。 |
| sourceStart | number | 否 | `this`实例中开始的偏移量。默认值:0。取值范围:0 <= sourceStart <= this.length。|
| sourceEnd | number | 否 | `this`实例中结束的偏移量(不包含结束位置)。默认值:当前对象的字节长度。取值范围:0 <= sourceEnd <= this.length。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| -1 \| 0 \| 1 | 返回比较结果。
-1:当前排列在目标前;
0:当前与目标相同;
1:当前排列在目标后。 |
**错误码:**
以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[语言基础类库错误码](errorcode-utils.md)。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 10200001 | Range error. Possible causes: The value of the parameter is not within the specified range. |
| 10200068 | The underlying ArrayBuffer is null or detach. |
**示例:**
```ts
import { fastbuffer } from '@kit.ArkTS';
let buf1 = fastbuffer.from([1, 2, 3, 4, 5, 6, 7, 8, 9]);
let buf2 = fastbuffer.from([5, 6, 7, 8, 9, 1, 2, 3, 4]);
console.info(buf1.compare(buf2, 5, 9, 0, 4).toString());
// 输出结果:0
console.info(buf1.compare(buf2, 0, 6, 4).toString());
// 输出结果:-1
console.info(buf1.compare(buf2, 5, 6, 5).toString());
// 输出结果:1
```
### copy
copy(target: FastBuffer| Uint8Array, targetStart?: number, sourceStart?: number, sourceEnd?: number): number
将`this`实例中指定位置的数据复制到`target`的指定位置上,并返回复制的字节总长度。
**原子化服务API**:从API version 20开始,该接口支持在原子化服务中使用。
**系统能力:** SystemCapability.Utils.Lang
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| target | [FastBuffer](#fastbuffer) \| Uint8Array | 是 | 要复制到的Buffer或Uint8Array实例。 |
| targetStart | number | 否 | `target`实例中开始写入的偏移量。默认值:0。取值范围:0 <= targetStart <= UINT32_MAX。 |
| sourceStart | number | 否 | `this`实例中开始复制的偏移量。默认值: 0。取值范围:0 <= sourceStart <= UINT32_MAX。 |
| sourceEnd | number | 否 | `this`实例中结束复制的偏移量(不包含结束位置)。默认值:当前对象的字节长度。取值范围:0 <= sourceEnd <= this.length。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| number | 复制的字节总长度。 |
**错误码:**
以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[语言基础类库错误码](errorcode-utils.md)。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 10200001 | Range error. Possible causes: The value of the parameter is not within the specified range. |
| 10200068 | The underlying ArrayBuffer is null or detach. |
**示例:**
```ts
import { fastbuffer } from '@kit.ArkTS';
let buf1 = fastbuffer.allocUninitializedFromPool(26);
let buf2 = fastbuffer.allocUninitializedFromPool(26).fill('!');
for (let i = 0; i < 26; i++) {
buf1.writeInt8(i + 97, i);
}
buf1.copy(buf2, 8, 16, 20);
console.info(buf2.toString('ascii', 0, 25));
// 输出结果:!!!!!!!!qrst!!!!!!!!!!!!!
```
### entries
entries(): IterableIterator<[number, number]>
返回一个包含key值和value值的迭代器。
**原子化服务API**:从API version 20开始,该接口支持在原子化服务中使用。
**系统能力:** SystemCapability.Utils.Lang
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| IterableIterator<[number, number]> | 包含key和value的迭代器,同时两者皆为number类型。 |
**示例:**
```ts
import { fastbuffer } from '@kit.ArkTS';
let buf = fastbuffer.from('buffer');
let pair = buf.entries();
let next: IteratorResult