@ohos.buffer (Buffer)

Buffer對象用于表示固定長度的字節序列，是專門存放二進制數據的緩存區。

推薦使用場景： 可用于處理大量二進制數據，圖片處理、文件接收上傳等。

說明：
本模塊首批接口從API version 9開始支持。后續版本的新增接口，采用上角標單獨標記接口的起始版本。

導入模塊

import buffer from '@ohos.buffer';

鴻蒙開發指導文檔：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]

搜狗高速瀏覽器截圖20240326151547.png

BufferEncoding

表示支持的編碼格式類型。

系統能力： 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'	表示十六進制格式。

buffer.alloc

alloc(size: number, fill?: string | Buffer | number, encoding?: BufferEncoding): Buffer

創建一定字節長度的Buffer對象，并初始化。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
size	number	是	指定的Buffer對象長度，單位：字節。
fill	string	Buffer	number
encoding	[BufferEncoding]	否	編碼格式（當`fill`為string時，才有意義）。默認值: 'utf8'。

返回值：

類型	說明
Buffer	返回一個Buffer對象。

示例：

import buffer from '@ohos.buffer';

let buf1 = buffer.alloc(5);
let buf2 = buffer.alloc(5, 'a');
let buf3 = buffer.alloc(11, 'aGVsbG8gd29ybGQ=', 'base64');

buffer.allocUninitializedFromPool

allocUninitializedFromPool(size: number): Buffer

創建指定大小未被初始化的Buffer對象。內存從緩沖池分配。創建的Buffer的內容未知，需要使用[fill]函數來初始化Buffer對象。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
size	number	是	指定的Buffer對象長度，單位：字節。

返回值：

類型	說明
Buffer	未初始化的Buffer實例。

示例：

import buffer from '@ohos.buffer';

let buf = buffer.allocUninitializedFromPool(10);
buf.fill(0);

buffer.allocUninitialized

allocUninitialized(size: number): Buffer

創建指定大小未被初始化的Buffer實例。內存不從緩沖池分配。創建的Buffer的內容未知，需要使用[fill]函數來初始化Buffer對象。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
size	number	是	指定的Buffer對象長度，單位：字節。

返回值：

類型	說明
Buffer	未初始化的Buffer實例。

示例：

import buffer from '@ohos.buffer';

let buf = buffer.allocUninitialized(10);
buf.fill(0);

buffer.byteLength

根據不同的編碼方法，返回指定字符串的字節數。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
string	string	Buffer	TypedArray
encoding	[BufferEncoding]	否	編碼格式。默認值: 'utf8'。

返回值：

類型	說明
number	返回指定字符串的字節數。

示例：

import buffer from '@ohos.buffer';

let str = 'u00bd + u00bc = u00be';
console.log(`${str}: ${str.length} characters, ${buffer.byteLength(str, 'utf-8')} bytes`);
// 打印: ? + ? = ?: 9 characters, 12 bytes

buffer.compare

compare(buf1: Buffer | Uint8Array, buf2: Buffer | Uint8Array): -1 | 0 | 1

返回兩個數組的比較結果，通常用于對Buffer對象數組進行排序。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
buf1	Buffer	Uint8Array	是
buf2	Buffer	Uint8Array	是

返回值：

類型	說明
-1	0

示例：

import buffer from '@ohos.buffer';

let buf1 = buffer.from('1234');
let buf2 = buffer.from('0123');
let res = buf1.compare(buf2);

console.log(Number(res).toString()); // 打印 1

buffer.concat

concat(list: Buffer[] | Uint8Array[], totalLength?: number): Buffer

將數組中的內容復制指定字節長度到新的Buffer對象中并返回。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
list	Buffer[]	Uint8Array[]	是
totalLength	number	否	需要復制的總字節長度。

返回值：

類型	說明
Buffer	返回新的Buffer對象。

錯誤碼：

以下錯誤碼的詳細介紹請參見[[語言基礎類庫錯誤碼]

錯誤碼ID	錯誤信息
10200001	The value of "length" is out of range. It must be >= 0 and <= uint32 max. Received value is: [length]

示例：

import buffer from '@ohos.buffer';

let buf1 = buffer.from("1234");
let buf2 = buffer.from("abcd");
let buf = buffer.concat([buf1, buf2]);
console.log(buf.toString('hex')); // 3132333461626364

buffer.from

from(array: number[]): Buffer;

根據指定數組創建新的Buffer對象。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
array	number[]	是	指定數組。

返回值：

類型	說明
Buffer	新的Buffer對象。

示例：

import buffer from '@ohos.buffer';

let buf = buffer.from([0x62, 0x75, 0x66, 0x66, 0x65, 0x72]);
console.log(buf.toString('hex')); // 627566666572

buffer.from

from(arrayBuffer: ArrayBuffer | SharedArrayBuffer, byteOffset?: number, length?: number): Buffer

創建指定長度的與arrayBuffer共享內存的Buffer對象。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
arrayBuffer	ArrayBuffer	SharedArrayBuffer	是
byteOffset	number	否	字節偏移量，默認值: 0。
length	number	否	字節長度，默認值: (arrayBuffer.byteLength - byteOffset)。

返回值：

類型	說明
Buffer	返回一個共享內存的Buffer對象。

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]

錯誤碼ID	錯誤信息
10200001	The value of "[byteOffset/length]" is out of range.

示例：

import buffer from '@ohos.buffer';

let ab = new ArrayBuffer(10);
let buf = buffer.from(ab, 0, 2);

buffer.from

from(buffer: Buffer | Uint8Array): Buffer

創建并復制buffer數據到新的Buffer對象并返回。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
buffer	Buffer	Uint8Array	是

返回值：

類型	說明
Buffer	新的Buffer對象。

示例：

import buffer from '@ohos.buffer';

let buf1 = buffer.from('buffer');
let buf2 = buffer.from(buf1);

buffer.from

from(object: Object, offsetOrEncoding: number | string, length: number): Buffer

根據指定的object類型數據，創建新的Buffer對象。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
object	Object	是	支持Symbol.toPrimitive或valueOf()的對象。
offsetOrEncoding	number	string	是
length	number	是	字節長度。

返回值：

類型	說明
Buffer	返回新的Buffer對象。

示例：

import buffer from '@ohos.buffer';

let buf = buffer.from(new String('this is a test'), 'utf8', 14);

buffer.from

from(string: String, encoding?: BufferEncoding): Buffer

根據指定編碼格式的字符串，創建新的Buffer對象。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
string	String	是	字符串
encoding	[BufferEncoding]	否	編碼格式。默認值: 'utf8'。

返回值：

類型	說明
Buffer	返回新的Buffer對象。

示例：

import buffer from '@ohos.buffer';

let buf1 = buffer.from('this is a test');
let buf2 = buffer.from('7468697320697320612074c3a97374', 'hex');

console.log(buf1.toString());	// 打印: this is a test
console.log(buf2.toString()); // 打印: this is a test

[](https://gitee.com/openharmony/docs/blob/OpenHarmony-3.2-Release/zh-cn/application-dev/reference/apis/js-apis-buffer.md#bufferisbuffer)buffer.isBuffer

isBuffer(obj: Object): boolean

判斷obj是否為Buffer。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
obj	Object	是	判斷對象

返回值：

類型	說明
boolean	如果obj是Buffer，則返回true，否則返回false。

示例：

import buffer from '@ohos.buffer';

let result = buffer.isBuffer(buffer.alloc(10)); // true
let result1 = buffer.isBuffer(buffer.from('foo')); // true
let result2 = buffer.isBuffer('a string'); // false
let result3 = buffer.isBuffer([]); // false
let result4 = buffer.isBuffer(new Uint8Array(1024)); // false

buffer.isEncoding

isEncoding(encoding: string): boolean

判斷encoding是否為支持的編碼格式。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
encoding	string	是	編碼格式。

返回值：

類型	說明
boolean	是支持的編碼格式返回true，反之則返回false。

示例：

import buffer from '@ohos.buffer';

console.log(buffer.isEncoding('utf-8').toString());	// 打印: true
console.log(buffer.isEncoding('hex').toString());	// 打印: true
console.log(buffer.isEncoding('utf/8').toString());	// 打印: false
console.log(buffer.isEncoding('').toString());	// 打印: false

buffer.transcode

transcode(source: Buffer | Uint8Array, fromEnc: string, toEnc: string): Buffer

將給定的Buffer或Uint8Array對象從一種字符編碼重新編碼為另一種。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
source	Buffer	Uint8Array	是
fromEnc	string	是	當前編碼。
toEnc	string	是	目標編碼。

返回值：

類型	說明
Buffer	根據當前編碼轉換成目標編碼，并返回一個新的buffer實例。

示例：

import buffer from '@ohos.buffer';

let buf = buffer.alloc(50);
let newBuf = buffer.transcode(buffer.from('€'), 'utf-8', 'ascii');
console.log(newBuf.toString('ascii'));

Buffer

屬性

系統能力： SystemCapability.Utils.Lang

名稱	類型	可讀	可寫	說明
length	number	是	否	Buffer對象的字節長度。
buffer	ArrayBuffer	是	否	ArrayBuffer對象。
byteOffset	number	是	否	當前Buffer所在內存池的偏移量。

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]

錯誤碼ID	錯誤信息
10200013	Cannot set property ${propertyName} of Buffer which has only a getter.

示例：

import buffer from '@ohos.buffer';

let buf = buffer.from("1236");
console.log(JSON.stringify(buf.length));
let arrayBuffer = buf.buffer;
console.log(JSON.stringify(new Uint8Array(arrayBuffer)));
console.log(JSON.stringify(buf.byteOffset));

compare

compare(target: Buffer | Uint8Array, targetStart?: number, targetEnd?: number, sourceStart?: number, sourceEnd?: number): -1 | 0 | 1

當前Buffer對象與目標Buffer對象進行比較，并返回Buffer在排序中的順序結果。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
target	Buffer	Uint8Array	是
targetStart	number	否	`target`實例中開始的偏移量。默認值: 0。
targetEnd	number	否	`target`實例中結束的偏移量（不包含結束位置）。默認值: 目標對象的字節長度。
sourceStart	number	否	`this`實例中開始的偏移量。默認值: 0。
sourceEnd	number	否	`this`實例中結束的偏移量（不包含結束位置）。默認值: 當前對象的字節長度。

返回值：

類型	說明
number	返回比較結果。-1：當前排列在目標前，0：當前與目標相同，1：當前排列在目標后。

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]

錯誤碼ID	錯誤信息
10200001	The value of "[targetStart/targetEnd/sourceStart/sourceEnd]" is out of range.

示例：

import buffer from '@ohos.buffer';

let buf1 = buffer.from([1, 2, 3, 4, 5, 6, 7, 8, 9]);
let buf2 = buffer.from([5, 6, 7, 8, 9, 1, 2, 3, 4]);

console.log(buf1.compare(buf2, 5, 9, 0, 4).toString());	// 打印: 0
console.log(buf1.compare(buf2, 0, 6, 4).toString());	// 打印: -1
console.log(buf1.compare(buf2, 5, 6, 5).toString());	// 打印: 1

copy

copy(target: Buffer| Uint8Array, targetStart?: number, sourceStart?: number, sourceEnd?: number): number

將this實例中指定位置的數據復制到target的指定位置上，并返回復制的字節總長度。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
target	Buffer	Uint8Array	是
targetStart	number	否	`target`實例中開始寫入的偏移量。默認值: 0。
sourceStart	number	否	`this`實例中開始復制的偏移量。默認值: 0。
sourceEnd	number	否	`this`實例中結束復制的偏移量（不包含結束位置）。默認值: 當前對象的字節長度。

返回值：

類型	說明
number	復制的字節總長度。

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]

錯誤碼ID	錯誤信息
10200001	The value of "[targetStart/sourceStart/sourceEnd]" is out of range.

示例：

import buffer from '@ohos.buffer';

let buf1 = buffer.allocUninitializedFromPool(26);
let buf2 = buffer.allocUninitializedFromPool(26).fill('!');

for (let i = 0; i < 26; i++) {
  buf1[i] = i + 97;
}

buf1.copy(buf2, 8, 16, 20);
console.log(buf2.toString('ascii', 0, 25));
// 打印: !!!!!!!!qrst!!!!!!!!!!!!!

entries

entries(): IterableIterator<[number, number]>

返回一個包含key和value的迭代器。

系統能力： SystemCapability.Utils.Lang

返回值：

類型	說明
IterableIterator<[number, number]>	包含key和value的迭代器，同時兩者皆為number類型。

示例：

import buffer from '@ohos.buffer';

let buf = buffer.from('buffer');
for (let pair of buf.entries()) {
  console.log(pair.toString());
}

equals

equals(otherBuffer: Uint8Array | Buffer): boolean

比較this實例和otherBuffer實例是否相等。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
otherBuffer	Uint8Array	Buffer	是

返回值：

類型	說明
boolean	相等則返回true，否則返回false。

示例：

import buffer from '@ohos.buffer';

let buf1 = buffer.from('ABC');
let buf2 = buffer.from('414243', 'hex');
let buf3 = buffer.from('ABCD');

console.log(buf1.equals(buf2).toString());	// 打印: true
console.log(buf1.equals(buf3).toString());	// 打印: false

fill

fill(value: string | Buffer | Uint8Array | number, offset?: number, end?: number, encoding?: BufferEncoding): Buffer

用value填充當前對象指定位置的數據，默認為循環填充，并返回填充后的Buffer對象。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
value	string	Buffer	Uint8Array
offset	number	否	起始偏移量。默認值: 0。
end	number	否	結束偏移量（不包含結束位置）。默認值: 當前對象的字節長度。
encoding	[BufferEncoding]	否	字符編碼格式（`value`為string才有意義）。默認值: 'utf8'。

返回值：

類型	說明
Buffer	返回一個填充后的Buffer對象。

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]

錯誤碼ID	錯誤信息
10200001	The value of "[offset/end]" is out of range.

示例：

import buffer from '@ohos.buffer';

let b = buffer.allocUninitializedFromPool(50).fill('h');
console.log(b.toString());

includes

includes(value: string | number | Buffer | Uint8Array, byteOffset?: number, encoding?: BufferEncoding): boolean

檢查Buffer對象是否包含value值。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
value	string	number	Buffer
byteOffset	number	否	字節偏移量。如果為負數，則從末尾開始計算偏移量。默認值: 0。
encoding	[BufferEncoding]	否	字符編碼格式。默認值: 'utf8'。

返回值：

類型	說明
boolean	存在為true，否則為false。

示例：

import buffer from '@ohos.buffer';

let buf = buffer.from('this is a buffer');
console.log(buf.includes('this').toString());	// 打印: true
console.log(buf.includes('be').toString());	// 打印: false

indexOf

indexOf(value: string | number | Buffer | Uint8Array, byteOffset?: number, encoding?: BufferEncoding): number

查找當前對象中第一次出現value的索引，如果不包含value，則為-1。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
value	string	number	Buffer
byteOffset	number	否	字節偏移量。如果為負數，則從末尾開始計算偏移量。默認值: 0。
encoding	[BufferEncoding]	否	字符編碼格式。默認值: 'utf8'。

返回值：

類型	說明
number	第一次出現位置。

示例：

import buffer from '@ohos.buffer';

let buf = buffer.from('this is a buffer');
console.log(buf.indexOf('this').toString());	// 打印: 0
console.log(buf.indexOf('is').toString());		// 打印: 2

keys

keys(): IterableIterator

返回一個包含key值的迭代器。

系統能力： SystemCapability.Utils.Lang

返回值：

類型	說明
IterableIterator	返回一個包含key值的迭代器。

示例：

import buffer from '@ohos.buffer';

let buf = buffer.from('buffer');
for (const key of buf.keys()) {
  console.log(key.toString());
}

lastIndexOf

lastIndexOf(value: string | number | Buffer | Uint8Array, byteOffset?: number, encoding?: BufferEncoding): number

返回this實例中最后一次出現value的索引，如果對象不包含，則為-1。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
value	string	number	Buffer
byteOffset	number	否	字節偏移量。如果為負數，則從末尾開始計算偏移量。默認值: 0。
encoding	[BufferEncoding])	否	字符編碼格式。默認值: 'utf8'。

返回值：

類型	說明
number	最后一次出現`value`值的索引。

示例：

import buffer from '@ohos.buffer';

let buf = buffer.from('this buffer is a buffer');
console.log(buf.lastIndexOf('this').toString());	// 打印: 0
console.log(buf.lastIndexOf('buffer').toString());	// 打印: 17

readBigInt64BE

readBigInt64BE(offset?: number): bigint

從指定的offset處讀取有符號的大端序64位整數。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
offset	number	否	偏移量。默認值: 0。

返回值：

類型	說明
bigint	讀取出的內容。

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]

錯誤碼ID	錯誤信息
10200001	The value of "offset" is out of range.

示例：

import buffer from '@ohos.buffer';

let buf = buffer.from([0x63, 0x64, 0x65, 0x66, 0x67, 0x68, 0x69, 0x70, 
        0x71, 0x72, 0x73, 0x74, 0x75, 0x76, 0x77, 0x78]);
console.log(buf.readBigInt64BE(0).toString());

let buf1 = buffer.allocUninitializedFromPool(8);
let result = buf1.writeBigInt64BE(BigInt(0x0102030405060708), 0);

readBigInt64LE

readBigInt64LE(offset?: number): bigint

從指定的offset處讀取有符號的小端序64位整數。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
offset	number	否	偏移量。默認值: 0。

返回值：

類型	說明
bigint	讀取出的內容。

錯誤碼：

以下錯誤碼的詳細介紹請參見語言基礎類庫錯誤碼。

錯誤碼ID	錯誤信息
10200001	The value of "offset" is out of range.

示例：

import buffer from '@ohos.buffer';

let buf = buffer.from([0x63, 0x64, 0x65, 0x66, 0x67, 0x68, 0x69, 0x70, 
        0x71, 0x72, 0x73, 0x74, 0x75, 0x76, 0x77, 0x78]);
console.log(buf.readBigInt64LE(0).toString());

let buf1 = buffer.allocUninitializedFromPool(8);
let result = buf1.writeBigInt64BE(BigInt(0x0102030405060708), 0);

readBigUInt64BE

readBigUInt64BE(offset?: number): bigint

從指定的offset處讀取無符號的大端序64位整數。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
offset	number	否	偏移量。默認值: 0。

返回值：

類型	說明
bigint	讀取出的內容。

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]

錯誤碼ID	錯誤信息
10200001	The value of "offset" is out of range.

示例：

import buffer from '@ohos.buffer';

let buf = buffer.from([0x63, 0x64, 0x65, 0x66, 0x67, 0x68, 0x69, 0x70, 
        0x71, 0x72, 0x73, 0x74, 0x75, 0x76, 0x77, 0x78]);
console.log(buf.readBigUInt64BE(0).toString());

let buf1 = buffer.allocUninitializedFromPool(8);
let result = buf1.writeBigUInt64BE(BigInt(0xdecafafecacefade), 0);

readBigUInt64LE

readBigUInt64LE(offset?: number): bigint

從指定的offset處讀取無符號的小端序64位整數。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
offset	number	否	偏移量。默認值: 0。

返回值：

類型	說明
bigint	讀取出的內容。

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]

錯誤碼ID	錯誤信息
10200001	The value of "offset" is out of range.

示例：

import buffer from '@ohos.buffer';

let buf = buffer.from([0x63, 0x64, 0x65, 0x66, 0x67, 0x68, 0x69, 0x70, 
        0x71, 0x72, 0x73, 0x74, 0x75, 0x76, 0x77, 0x78]);
console.log(buf.readBigUInt64LE(0).toString());

let buf1 = buffer.allocUninitializedFromPool(8);
let result = buf1.writeBigUInt64BE(BigInt(0xdecafafecacefade), 0);

readDoubleBE

readDoubleBE(offset?: number): number

從指定offset處讀取64位大端序雙精度值。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
offset	number	否	偏移量。默認值: 0。

返回值：

類型	說明
number	讀取出的內容。

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]

錯誤碼ID	錯誤信息
10200001	The value of "offset" is out of range.

示例：

import buffer from '@ohos.buffer';

let buf = buffer.from([1, 2, 3, 4, 5, 6, 7, 8]);
console.log(buf.readDoubleBE(0).toString());

let buf1 = buffer.allocUninitializedFromPool(8);
let result = buf1.writeDoubleBE(123.456, 0);

readDoubleLE

readDoubleLE(offset?: number): number

從指定offset處讀取64位小端序雙精度值。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
offset	number	否	偏移量。默認值: 0。

返回值：

類型	說明
number	讀取出的內容。

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]

錯誤碼ID	錯誤信息
10200001	The value of "offset" is out of range.

示例：

import buffer from '@ohos.buffer';

let buf = buffer.from([1, 2, 3, 4, 5, 6, 7, 8]);
console.log(buf.readDoubleLE(0).toString());

let buf1 = buffer.allocUninitializedFromPool(8);
let result = buf1.writeDoubleLE(123.456, 0);

readFloatBE

readFloatBE(offset?: number): number

從指定offset處讀取32位大端序浮點數。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
offset	number	否	偏移量。默認值: 0。

返回值：

類型	說明
number	讀取出的內容。

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]

錯誤碼ID	錯誤信息
10200001	The value of "offset" is out of range.

示例：

import buffer from '@ohos.buffer';

let buf = buffer.from([1, 2, 3, 4, 5, 6, 7, 8]);
console.log(buf.readFloatBE(0).toString());

let buf1 = buffer.allocUninitializedFromPool(4);
let result = buf1.writeFloatBE(0xcabcbcbc, 0);

readFloatLE

readFloatLE(offset?: number): number

從指定offset處讀取32位小端序浮點數。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
offset	number	否	偏移量。默認值: 0。

返回值：

類型	說明
number	讀取出的內容。

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]

錯誤碼ID	錯誤信息
10200001	The value of "offset" is out of range.

示例：

import buffer from '@ohos.buffer';

let buf = buffer.from([1, 2, 3, 4, 5, 6, 7, 8]);
console.log(buf.readFloatLE(0).toString());

let buf1 = buffer.allocUninitializedFromPool(4);
let result = buf1.writeFloatLE(0xcabcbcbc, 0);

readInt8

readInt8(offset?: number): number

從指定的offset處讀取有符號的8位整數。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
offset	number	否	偏移量。默認值: 0。

返回值：

類型	說明
number	讀取出的內容。

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]

錯誤碼ID	錯誤信息
10200001	The value of "offset" is out of range.

示例：

import buffer from '@ohos.buffer';

let buf = buffer.from([-1, 5]);
console.log(buf.readInt8(0).toString());	// 打印: 0
console.log(buf.readInt8(1).toString());	// 打印: 5

let buf1 = buffer.allocUninitializedFromPool(2);
let result = buf1.writeInt8(0x12);

readInt16BE

readInt16BE(offset?: number): number

從指定的offset處讀取有符號的大端序16位整數。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
offset	number	否	偏移量。默認值: 0。

返回值：

類型	說明
number	讀取出的內容。

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]

錯誤碼ID	錯誤信息
10200001	The value of "offset" is out of range.

示例：

import buffer from '@ohos.buffer';

let buf = buffer.from([0, 5]);
console.log(buf.readInt16BE(0).toString());	// 打印: 5

let buf1 = buffer.alloc(2);
let result = buf1.writeInt16BE(0x1234, 0);

readInt16LE

readInt16LE(offset?: number): number

從指定的offset處讀取有符號的小端序16位整數。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
offset	number	否	偏移量。默認值: 0。

返回值：

類型	說明
number	讀取出的內容。

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]

錯誤碼ID	錯誤信息
10200001	The value of "offset" is out of range.

示例：

import buffer from '@ohos.buffer';

let buf = buffer.from([0, 5]);
console.log(buf.readInt16LE(0).toString());	// 打印: 1280

let buf1 = buffer.alloc(2);
let result = buf1.writeInt16BE(0x1234, 0);

readInt32BE

readInt32BE(offset?: number): number

從指定的offset處讀取有符號的大端序32位整數。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
offset	number	否	偏移量。默認值: 0。

返回值：

類型	說明
number	讀取出的內容。

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]

錯誤碼ID	錯誤信息
10200001	The value of "offset" is out of range.

示例：

import buffer from '@ohos.buffer';

let buf = buffer.from([0, 0, 0, 5]);
console.log(buf.readInt32BE(0).toString());	// 打印: 5

let buf1 = buffer.alloc(4);
let result = buf1.writeInt32BE(0x12345678, 0);

readInt32LE

readInt32LE(offset?: number): number

從指定的offset處讀取有符號的小端序32位整數。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
offset	number	否	偏移量。默認值: 0。

返回值：

類型	說明
number	讀取出的內容。

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]

錯誤碼ID	錯誤信息
10200001	The value of "offset" is out of range.

示例：

import buffer from '@ohos.buffer';

let buf = buffer.from([0, 0, 0, 5]);
console.log(buf.readInt32LE(0).toString());	// 打印: 83886080

let buf1 = buffer.alloc(4);
let result = buf1.writeInt32BE(0x12345678, 0);

readIntBE

readIntBE(offset: number, byteLength: number): number

從指定的offset處的buf讀取byteLength個字節，并將結果解釋為支持最高48位精度的大端序、二進制補碼有符號值。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
offset	number	是	偏移量。默認值: 0。
byteLength	number	是	讀取的字節數。

返回值：

類型	說明
number	讀取的內容。

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]

錯誤碼ID	錯誤信息
10200001	The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]

示例：

import buffer from '@ohos.buffer';

let buf = buffer.from("ab");
let num = buf.readIntBE(0, 1);
console.log(num.toString()); // 97

let buf1 = buffer.allocUninitializedFromPool(6);
let result = buf1.writeIntBE(0x123456789011, 0, 6);

readIntLE

readIntLE(offset: number, byteLength: number): number

從指定的offset處的buf讀取byteLength個字節，并將結果解釋為支持最高48位精度的小端序、二進制補碼有符號值。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
offset	number	是	偏移量。默認值: 0。
byteLength	number	是	讀取的字節數。

返回值：

類型	說明
number	讀取出的內容。

錯誤碼：

以下錯誤碼的詳細介紹請參見語言基礎類庫錯誤碼。

錯誤碼ID	錯誤信息
10200001	The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]

示例：

import buffer from '@ohos.buffer';

let buf = buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);
console.log(buf.readIntLE(0, 6).toString(16));

let buf1 = buffer.allocUninitializedFromPool(6);
let result = buf1.writeIntLE(0x123456789011, 0, 6);

readUInt8

readUInt8(offset?: number): number

從offset處讀取8位無符號整型數。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
offset	number	否	偏移量。默認值: 0。

返回值：

類型	說明
number	讀取出的內容。

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]

錯誤碼ID	錯誤信息
10200001	The value of "offset" is out of range.

示例：

import buffer from '@ohos.buffer';

let buf = buffer.from([1, -2]);
console.log(buf.readUInt8(0).toString());
console.log(buf.readUInt8(1).toString());

let buf1 = buffer.allocUninitializedFromPool(4);
let result = buf1.writeUInt8(0x42);

readUInt16BE

readUInt16BE(offset?: number): number

從指定的offset處的buf讀取無符號的大端序16位整數。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
offset	number	否	偏移量。默認值: 0。

返回值：

類型	說明
number	讀取出的內容。

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]

錯誤碼ID	錯誤信息
10200001	The value of "offset" is out of range.

示例：

import buffer from '@ohos.buffer';

let buf = buffer.from([0x12, 0x34, 0x56]);
console.log(buf.readUInt16BE(0).toString(16));
console.log(buf.readUInt16BE(1).toString(16));

let buf1 = buffer.allocUninitializedFromPool(4);
let result = buf1.writeUInt16BE(0x1234, 0);

readUInt16LE

readUInt16LE(offset?: number): number

從指定的offset處的buf讀取無符號的小端序16位整數。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
offset	number	否	偏移量。默認值: 0。

返回值：

類型	說明
number	讀取出的內容。

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]

錯誤碼ID	錯誤信息
10200001	The value of "offset" is out of range.

示例：

import buffer from '@ohos.buffer';

let buf = buffer.from([0x12, 0x34, 0x56]);
console.log(buf.readUInt16LE(0).toString(16));
console.log(buf.readUInt16LE(1).toString(16));

let buf1 = buffer.allocUninitializedFromPool(4);
let result = buf1.writeUInt16LE(0x1234, 0);

readUInt32BE

readUInt32BE(offset?: number): number

從指定的offset處的buf讀取無符號的大端序32位整數。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
offset	number	否	偏移量。默認值: 0。

返回值：

類型	說明
number	讀取出的內容。

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]

錯誤碼ID	錯誤信息
10200001	The value of "offset" is out of range.

示例：

import buffer from '@ohos.buffer';

let buf = buffer.from([0x12, 0x34, 0x56, 0x78]);
console.log(buf.readUInt32BE(0).toString(16));

let buf1 = buffer.allocUninitializedFromPool(4);
let result = buf1.writeUInt32BE(0x12345678, 0);

readUInt32LE

readUInt32LE(offset?: number): number

從指定的offset處的buf讀取無符號的小端序32位整數。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
offset	number	否	偏移量。默認值: 0。

返回值：

類型	說明
number	讀取出的內容。

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]

錯誤碼ID	錯誤信息
10200001	The value of "offset" is out of range.

示例：

import buffer from '@ohos.buffer';

let buf = buffer.from([0x12, 0x34, 0x56, 0x78]);
console.log(buf.readUInt32LE(0).toString(16));

let buf1 = buffer.allocUninitializedFromPool(4);
let result = buf1.writeUInt32LE(0x12345678, 0);

readUIntBE

readUIntBE(offset: number, byteLength: number): number

從指定的offset處的buf讀取byteLength個字節，并將結果解釋為支持最高48位精度的無符號大端序整數。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
offset	number	是	偏移量。默認值: 0。
byteLength	number	是	要讀取的字節數。

返回值：

類型	說明
number	讀取出的內容。

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]

錯誤碼ID	錯誤信息
10200001	The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]

示例：

import buffer from '@ohos.buffer';

let buf = buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);
console.log(buf.readUIntBE(0, 6).toString(16));

let buf1 = buffer.allocUninitializedFromPool(4);
let result = buf1.writeUIntBE(0x13141516, 0, 4);

readUIntLE

readUIntLE(offset: number, byteLength: number): number

從指定的offset處的buf讀取byteLength個字節，并將結果解釋為支持最高48位精度的無符號小端序整數。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
offset	number	是	偏移量。默認值: 0。
byteLength	number	是	要讀取的字節數。

返回值：

類型	說明
number	讀取出的內容。

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]

錯誤碼ID	錯誤信息
10200001	The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]

示例：

import buffer from '@ohos.buffer';

let buf = buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);
console.log(buf.readUIntLE(0, 6).toString(16));

let buf1 = buffer.allocUninitializedFromPool(4);
let result = buf1.writeUIntLE(0x13141516, 0, 4);

subarray

subarray(start?: number, end?: number): Buffer

截取當前對象指定位置的數據并返回。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
start	number	否	截取開始位置。默認值: 0。
end	number	否	截取結束位置（不包含結束位置）。默認值: 當前對象的字節長度。

返回值：

類型	說明
Buffer	返回新的Buffer對象。

示例：

import buffer from '@ohos.buffer';

let buf1 = buffer.allocUninitializedFromPool(26);

for (let i = 0; i < 26; i++) {
  buf1[i] = i + 97;
}
const buf2 = buf1.subarray(0, 3);
console.log(buf2.toString('ascii', 0, buf2.length));
// 打印: abc

swap16

swap16(): Buffer

將當前對象解釋為無符號的16位整數數組，并交換字節順序。

系統能力： SystemCapability.Utils.Lang

返回值：

類型	說明
Buffer	交換之后的Buffer實例。

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]

錯誤碼ID	錯誤信息
10200009	Buffer size must be a multiple of 16-bits

示例：

import buffer from '@ohos.buffer';

let buf1 = buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]);
console.log(buf1.toString('hex'));	// 打印: 0102030405060708

buf1.swap16();
console.log(buf1.toString('hex'));	// 打印: 0201040306050807

swap32

swap32(): Buffer

將當前對象解釋為無符號的32位整數數組，并交換字節順序。

系統能力： SystemCapability.Utils.Lang

返回值：

類型	說明
Buffer	交換之后的Buffer對象。

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]

錯誤碼ID	錯誤信息
10200009	Buffer size must be a multiple of 32-bits

示例：

import buffer from '@ohos.buffer';

let buf1 = buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]);
console.log(buf1.toString('hex'));	// 打印: 0102030405060708

buf1.swap32();
console.log(buf1.toString('hex'));	// 打印: 0403020108070605

swap64

swap64(): Buffer

將當前對象解釋為無符號的64位整數數組，并交換字節順序。

系統能力： SystemCapability.Utils.Lang

返回值：

類型	說明
Buffer	交換之后的Buffer對象。

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]

錯誤碼ID	錯誤信息
10200009	Buffer size must be a multiple of 64-bits

示例：

import buffer from '@ohos.buffer';

let buf1 = buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]);
console.log(buf1.toString('hex'));	// 打印: 0102030405060708
buf1.swap64();
console.log(buf1.toString('hex'));	// 打印: 0807060504030201

toJSON

toJSON(): Object

將Buffer轉為JSON并返回。

系統能力： SystemCapability.Utils.Lang

返回值：

類型	說明
Object	JSON對象。

示例：

import buffer from '@ohos.buffer';

let buf1 = buffer.from([0x1, 0x2, 0x3, 0x4, 0x5]);
let obj = buf1.toJSON();
console.log(JSON.stringify(obj));
// 打印: {"type":"Buffer","data":[1,2,3,4,5]}

toString

toString(encoding?: string, start?: number, end?: number): string

將當前對象中指定位置數據轉成指定編碼格式字符串并返回。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
encoding	string	否	字符編碼格式。默認值: 'utf8'。
start	number	否	開始位置。默認值: 0。
end	number	否	結束位置。默認值: Buffer.length。

返回值：

類型	說明
string	字符串。

示例：

import buffer from '@ohos.buffer';

let buf1 = buffer.allocUninitializedFromPool(26);
for (let i = 0; i < 26; i++) {
  buf1[i] = i + 97;
}
console.log(buf1.toString('utf-8'));
// 打印: abcdefghijklmnopqrstuvwxyz

values

values(): IterableIterator

返回一個包含value的迭代器。

系統能力： SystemCapability.Utils.Lang

返回值：

類型	說明
IterableIterator	迭代器。

示例：

import buffer from '@ohos.buffer';

let buf1 = buffer.from('buffer');
for (let value of buf1.values()) {
  console.log(value.toString());
}

write

write(str: string, offset?: number, length?: number, encoding?: string): number

從Buffer對象的offset偏移寫入指定編碼的字符串str，寫入的字節長度為length。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
str	string	是	要寫入Buffer的字符串。
offset	number	否	偏移量。默認值: 0。
length	number	否	最大字節長度。默認值: (Buffer.length - offset)。
encoding	string	否	字符編碼。默認值: 'utf8'。

返回值：

類型	說明
number	返回寫入的字節數。

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]

錯誤碼ID	錯誤信息
10200001	The value of "[offset/length]" is out of range.

示例：

import buffer from '@ohos.buffer';

let buf = buffer.alloc(256);
let len = buf.write('u00bd + u00bc = u00be', 0);
console.log(`${len} bytes: ${buf.toString('utf-8', 0, len)}`);
// 打印: 12 bytes: ? + ? = ?

let buffer1 = buffer.alloc(10);
let length = buffer1.write('abcd', 8);

writeBigInt64BE

writeBigInt64BE(value: bigint, offset?: number): number

從Buffer對象的offset偏移寫入有符號的大端序64位BigInt型數據value。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
value	bigint	是	寫入Buffer的數據。
offset	number	否	偏移量。默認值: 0。

返回值：

類型	說明
number	寫入的字節數。

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]

錯誤碼ID	錯誤信息
10200001	The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]

示例：

import buffer from '@ohos.buffer';

let buf = buffer.allocUninitializedFromPool(8);
let result = buf.writeBigInt64BE(BigInt(0x0102030405060708), 0);

writeBigInt64LE

writeBigInt64LE(value: bigint, offset?: number): number

從Buffer對象的offset偏移寫入有符號的小端序64位BigInt型數據value。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
value	bigint	是	寫入Buffer的數據。
offset	number	否	偏移量。默認值: 0。

返回值：

類型	說明
number	寫入的字節數。

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]

錯誤碼ID	錯誤信息
10200001	The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]

示例：

import buffer from '@ohos.buffer';

let buf = buffer.allocUninitializedFromPool(8);
let result = buf.writeBigInt64LE(BigInt(0x0102030405060708), 0);

writeBigUInt64BE

writeBigUInt64BE(value: bigint, offset?: number): number

從Buffer對象的offset偏移寫入無符號的大端序64位BigUInt型數據value。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
value	bigint	是	寫入Buffer的數據。
offset	number	否	偏移量。默認值: 0。

返回值：

類型	說明
number	寫入的字節數。

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]

錯誤碼ID	錯誤信息
10200001	The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]

示例：

import buffer from '@ohos.buffer';

let buf = buffer.allocUninitializedFromPool(8);
let result = buf.writeBigUInt64BE(BigInt(0xdecafafecacefade), 0);

writeBigUInt64LE

writeBigUInt64LE(value: bigint, offset?: number): number

從Buffer對象的offset偏移寫入無符號的小端序64位BigUInt型數據value。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
value	bigint	是	寫入Buffer的數據。
offset	number	否	偏移量。默認值: 0。

返回值：

類型	說明
number	寫入的字節數。

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]

錯誤碼ID	錯誤信息
10200001	The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]

示例：

import buffer from '@ohos.buffer';

let buf = buffer.allocUninitializedFromPool(8);
let result = buf.writeBigUInt64LE(BigInt(0xdecafafecacefade), 0);

writeDoubleBE

writeDoubleBE(value: number, offset?: number): number

從Buffer對象的offset偏移寫入大端序的64位雙浮點型數據value。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
value	number	是	寫入Buffer的數據。
offset	number	否	偏移量。默認值: 0。

返回值：

類型	說明
number	寫入的字節數。

錯誤碼：

以下錯誤碼的詳細介紹請參見語言基礎類庫錯誤碼。

錯誤碼ID	錯誤信息
10200001	The value of "offset" is out of range. It must be >= 0 and <= buf.length - 8. Received value is: [offset]

示例：

import buffer from '@ohos.buffer';

let buf = buffer.allocUninitializedFromPool(8);
let result = buf.writeDoubleBE(123.456, 0);

writeDoubleLE

writeDoubleLE(value: number, offset?: number): number

從Buffer對象的offset偏移寫入小端序的64位雙浮點型數據value。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
value	number	是	寫入Buffer的數據。
offset	number	否	偏移量。默認值: 0。

返回值：

類型	說明
number	寫入的字節數。

錯誤碼：

以下錯誤碼的詳細介紹請參見語言基礎類庫錯誤碼。

錯誤碼ID	錯誤信息
10200001	The value of "offset" is out of range. It must be >= 0 and <= buf.length - 8. Received value is: [offset]

示例：

import buffer from '@ohos.buffer';

let buf = buffer.allocUninitializedFromPool(8);
let result = buf.writeDoubleLE(123.456, 0);

writeFloatBE

writeFloatBE(value: number, offset?: number): number

從Buffer對象的offset偏移寫入大端序的32位浮點型數據value。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
value	number	是	寫入Buffer的數據。
offset	number	否	偏移量。默認值: 0。

返回值：

類型	說明
number	寫入的字節數。

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]

錯誤碼ID	錯誤信息
10200001	The value of "offset" is out of range. It must be >= 0 and <= buf.length - 4. Received value is: [offset]

示例：

import buffer from '@ohos.buffer';

let buf = buffer.allocUninitializedFromPool(8);
let result = buf.writeFloatBE(0xcafebabe, 0);

writeFloatLE

writeFloatLE(value: number, offset?: number): number

從Buffer對象的offset偏移寫入小端序的32位浮點型數據value。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
value	number	是	寫入Buffer的數據。
offset	number	否	偏移量。默認值: 0。

返回值：

類型	說明
number	寫入的字節數。

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]

錯誤碼ID	錯誤信息
10200001	The value of "offset" is out of range. It must be >= 0 and <= buf.length - 4. Received value is: [offset]

示例：

import buffer from '@ohos.buffer';

let buf = buffer.allocUninitializedFromPool(8);
let result = buf.writeFloatLE(0xcafebabe, 0);

writeInt8

writeInt8(value: number, offset?: number): number

從Buffer對象的offset偏移寫入8位有符號整型數據value。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
value	number	是	寫入Buffer的數據。
offset	number	否	偏移量。默認值: 0。

返回值：

類型	說明
number	寫入的字節數。

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]

錯誤碼ID	錯誤信息
10200001	The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]

示例：

import buffer from '@ohos.buffer';

let buf = buffer.allocUninitializedFromPool(2);
let result = buf.writeInt8(2, 0);
let result1 = buf.writeInt8(-2, 1);

writeInt16BE

writeInt16BE(value: number, offset?: number): number

從Buffer對象的offset偏移寫入大端序的16位有符號整型數據value。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
value	number	是	寫入Buffer的數據。
offset	number	否	偏移量。默認值: 0。

返回值：

類型	說明
number	寫入的字節數。

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]

錯誤碼ID	錯誤信息
10200001	The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]

示例：

import buffer from '@ohos.buffer';

let buf = buffer.allocUninitializedFromPool(2);
let result = buf.writeInt16BE(0x0102, 0);

writeInt16LE

writeInt16LE(value: number, offset?: number): number

從Buffer對象的offset偏移寫入小端序的16位有符號整型數據value。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
value	number	是	寫入Buffer的數據。
offset	number	否	偏移量。默認值: 0。

返回值：

類型	說明
number	寫入的字節數。

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]

錯誤碼ID	錯誤信息
10200001	The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]

示例：

import buffer from '@ohos.buffer';

let buf = buffer.allocUninitializedFromPool(2);
let result = buf.writeInt16LE(0x0304, 0);

writeInt32BE

writeInt32BE(value: number, offset?: number): number

從Buffer對象的offset偏移寫入大端序的32位有符號整型數據value。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
value	number	是	寫入Buffer的數據。
offset	number	否	偏移量。默認值: 0。

返回值：

類型	說明
number	寫入的字節數。

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]

錯誤碼ID	錯誤信息
10200001	The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]

示例：

import buffer from '@ohos.buffer';

let buf = buffer.allocUninitializedFromPool(4);
let result = buf.writeInt32BE(0x01020304, 0);

writeInt32LE

writeInt32LE(value: number, offset?: number): number

從Buffer對象的offset偏移寫入小端序的32位有符號整型數據value。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
value	number	是	寫入Buffer的數據。
offset	number	否	偏移量。默認值: 0。

返回值：

類型	說明
number	寫入的字節數。

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]

錯誤碼ID	錯誤信息
10200001	The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]

示例：

import buffer from '@ohos.buffer';

let buf = buffer.allocUninitializedFromPool(4);
let result = buf.writeInt32LE(0x05060708, 0);

writeIntBE

writeIntBE(value: number, offset: number, byteLength: number): number

從Buffer對象的offset偏移寫入大端序的有符號value數據，value字節長度為byteLength。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
value	number	是	寫入Buffer的數據。
offset	number	是	偏移量。默認值: 0。
byteLength	number	是	要寫入的字節數。

返回值：

類型	說明
number	寫入的字節數。

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]

錯誤碼ID	錯誤信息
10200001	The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]

示例：

import buffer from '@ohos.buffer';

let buf = buffer.allocUninitializedFromPool(6);
let result = buf.writeIntBE(0x1234567890ab, 0, 6);

writeIntLE

writeIntLE(value: number, offset: number, byteLength: number): number

從Buffer對象的offset偏移寫入小端序的有符號value數據，value字節長度為byteLength。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
value	number	是	寫入Buffer的數據。
offset	number	是	偏移量。默認值: 0。
byteLength	number	是	要寫入的字節數。

返回值：

類型	說明
number	寫入的字節數。

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]

錯誤碼ID	錯誤信息
10200001	The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]

示例：

import buffer from '@ohos.buffer';

let buf = buffer.allocUninitializedFromPool(6);
let result = buf.writeIntLE(0x1234567890ab, 0, 6);

writeUInt8

writeUInt8(value: number, offset?: number): number

從Buffer對象的offset偏移寫入8位無符號整型數據value。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
value	number	是	寫入Buffer的數據。
offset	number	否	偏移量。默認值: 0。

返回值：

類型	說明
number	寫入的字節數。

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]

錯誤碼ID	錯誤信息
10200001	The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]

示例：

import buffer from '@ohos.buffer';

let buf = buffer.allocUninitializedFromPool(4);
let result = buf.writeUInt8(0x3, 0);
let result1 = buf.writeUInt8(0x4, 1);
let result2 = buf.writeUInt8(0x23, 2);
let result3 = buf.writeUInt8(0x42, 3);

writeUInt16BE

writeUInt16BE(value: number, offset?: number): number

從Buffer對象的offset偏移寫入大端序的16位無符號整型數據value。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
value	number	是	寫入Buffer的數據。
offset	number	否	偏移量。默認值為0。

返回值：

類型	說明
number	寫入的字節數。

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]

錯誤碼ID	錯誤信息
10200001	The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]

示例：

import buffer from '@ohos.buffer';

let buf = buffer.allocUninitializedFromPool(4);
let result = buf.writeUInt16BE(0xdead, 0);
let result1 = buf.writeUInt16BE(0xbeef, 2);

writeUInt16LE

writeUInt16LE(value: number, offset?: number): number

從Buffer對象的offset偏移寫入小端序的16位無符號整型數據value。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
value	number	是	寫入Buffer的數據。
offset	number	否	偏移量。默認值: 0。

返回值：

類型	說明
number	寫入的字節數。

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]

錯誤碼ID	錯誤信息
10200001	The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]

示例：

import buffer from '@ohos.buffer';

let buf = buffer.allocUninitializedFromPool(4);
let result = buf.writeUInt16LE(0xdead, 0);
let result1 = buf.writeUInt16LE(0xbeef, 2);

writeUInt32BE

writeUInt32BE(value: number, offset?: number): number

從Buffer對象的offset偏移寫入大端序的32位無符號整型數據value。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
value	number	是	寫入Buffer的數據。
offset	number	否	偏移量。默認值: 0。

返回值：

類型	說明
number	寫入的字節數。

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]

錯誤碼ID	錯誤信息
10200001	The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]

示例：

import buffer from '@ohos.buffer';

let buf = buffer.allocUninitializedFromPool(4);
let result = buf.writeUInt32BE(0xfeedface, 0);

writeUInt32LE

writeUInt32LE(value: number, offset?: number): number

從Buffer對象的offset偏移寫入小端序的32位無符號整型數據value。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
value	number	是	寫入Buffer對象的數字。
offset	number	否	偏移量。默認值: 0。

返回值：

類型	說明
number	寫入的字節數。

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]

錯誤碼ID	錯誤信息
10200001	The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]

示例：

import buffer from '@ohos.buffer';

let buf = buffer.allocUninitializedFromPool(4);
let result = buf.writeUInt32LE(0xfeedface, 0);

writeUIntBE

writeUIntBE(value: number, offset: number, byteLength: number): number

從Buffer對象的offset偏移寫入大端序的無符號value數據，value字節長度為byteLength。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
value	number	是	寫入Buffer的數據。
offset	number	是	偏移量。默認值: 0。
byteLength	number	是	要寫入的字節數。

返回值：

類型	說明
number	寫入的字節數。

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]

錯誤碼ID	錯誤信息
10200001	The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]

示例：

import buffer from '@ohos.buffer';

let buf = buffer.allocUninitializedFromPool(6);
let result = buf.writeUIntBE(0x1234567890ab, 0, 6);

writeUIntLE

writeUIntLE(value: number, offset: number, byteLength: number): number

從Buffer對象的offset偏移寫入小端序的無符號value數據，value字節長度為byteLength。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
value	number	是	寫入Buffer的數據。
offset	number	是	偏移量。默認值: 0。
byteLength	number	是	要寫入的字節數。

返回值：

類型	說明
number	寫入的字節數。

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]

錯誤碼ID	錯誤信息
10200001	The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param]

示例：

import buffer from '@ohos.buffer';

let buf = buffer.allocUninitializedFromPool(6);
let result = buf.writeUIntLE(0x1234567890ab, 0, 6);

Blob

屬性

系統能力： SystemCapability.Utils.Lang

名稱	類型	可讀	可寫	說明
size	number	是	否	Blob實例的總字節大小。
type	string	是	否	Blob實例的內容類型。

constructor

constructor(sources: string[] | ArrayBuffer[] | TypedArray[] | DataView[] | Blob[] , options?: Object)

Blob的構造函數。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
sources	string[]	ArrayBuffer[]	TypedArray[]
options	Object	否	options: - endings:含義為結束符'n'的字符串如何被輸出，為'transparent'或'native'。native代表行結束符會跟隨系統。'transparent'代表會保持Blob中保存的結束符不變。此參數非必填，默認值為'transparent'。 - type:Blob內容類型。其目的是讓類型傳達數據的MIME媒體類型，但是不執行類型格式的驗證。此參數非必填，默認參數為''。

示例：

import buffer from '@ohos.buffer';

let blob = new buffer.Blob(['a', 'b', 'c']);
let blob1 = new buffer.Blob(['a', 'b', 'c'], {endings:'native', type: 'MIME'});

arrayBuffer

arrayBuffer(): Promise

將Blob中的數據放入到ArrayBuffer中，并返回一個Promise。

系統能力： SystemCapability.Utils.Lang

返回值：

類型	說明
Promise	Promise對象，返回包含Blob數據的ArrayBuffer。

示例：

let blob = new buffer.Blob(['a', 'b', 'c']);
let pro = blob.arrayBuffer();
pro.then(val = > {
  let uintarr = new Uint8Array(val);
  console.log(uintarr.toString());
});

slice

slice(start?: number, end?: number, type?: string): Blob

創建并返回一個復制原Blob對象中指定數據長度的Blob新對象。

系統能力： SystemCapability.Utils.Lang

參數：

參數名	類型	必填	說明
start	number	否	起始位置。默認值為0。
end	number	否	結束位置。默認值為原Blob對象中的數據長度。
type	string	否	內容類型。默認值為''。

返回值：

類型	說明
Blob	新的Blob實例對象。

示例：

let blob = new buffer.Blob(['a', 'b', 'c']);
let blob2 = blob.slice(0, 2);
let blob3 = blob.slice(0, 2, "MIME");

text

text(): Promise

使用UTF8進行解碼并返回一個文本。使用Promise異步回調。

系統能力： SystemCapability.Utils.Lang

返回值：

類型	說明
Promise	Promise對象，返回包含以UTF8解碼的文本。

示例：

let blob = new buffer.Blob(['a', 'b', 'c']);
let pro = blob.text();
pro.then(val = > {
    console.log(val);
});

審核編輯黃宇

聲明：本文內容及配圖由入駐作者撰寫或者入駐合作網站授權轉載。文章觀點僅代表作者本人，不代表電子發燒友網立場。文章及其配圖僅供工程師學習之用，如有內容侵權或者其他違規問題，請聯系本站處理。舉報投訴

鴻蒙

鴻蒙

+關注

關注
57

文章
2395

瀏覽量
43091
OpenHarmony

OpenHarmony

+關注

關注
25

文章
3752

瀏覽量
16661

搜索歷史

OpenHarmony語言基礎類庫【@ohos.buffer (Buffer)】

@ohos.buffer (Buffer)

導入模塊

BufferEncoding

buffer.alloc

buffer.allocUninitializedFromPool

buffer.allocUninitialized

buffer.byteLength

buffer.compare

buffer.concat

buffer.from

buffer.from

buffer.from

buffer.from

buffer.from

[](https://gitee.com/openharmony/docs/blob/OpenHarmony-3.2-Release/zh-cn/application-dev/reference/apis/js-apis-buffer.md#bufferisbuffer)buffer.isBuffer

buffer.isEncoding

buffer.transcode

Buffer

屬性

compare

copy

entries

equals

fill

includes

indexOf

keys

lastIndexOf

readBigInt64BE

readBigInt64LE

readBigUInt64BE

readBigUInt64LE

readDoubleBE

readDoubleLE

readFloatBE

readFloatLE

readInt8

readInt16BE

readInt16LE

readInt32BE

readInt32LE

readIntBE

readIntLE

readUInt8

readUInt16BE

readUInt16LE

readUInt32BE

readUInt32LE

readUIntBE

readUIntLE

subarray

swap16

swap32

swap64

toJSON

toString

values

write

writeBigInt64BE

writeBigInt64LE

writeBigUInt64BE

writeBigUInt64LE

writeDoubleBE

writeDoubleLE

writeFloatBE

writeFloatLE

writeInt8

writeInt16BE

writeInt16LE

writeInt32BE

writeInt32LE

writeIntBE

writeIntLE

writeUInt8

writeUInt16BE

writeUInt16LE

writeUInt32BE

writeUInt32LE