PipeArrayBuffer
Defined in: packages/candid/src/utils/buffer.ts:18
A class that abstracts a pipe-like Uint8Array.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new PipeArrayBuffer(
buffer?,length?):PipeArrayBuffer
Defined in: packages/candid/src/utils/buffer.ts:54
Creates a new instance of a pipe
Parameters
Section titled “Parameters”buffer?
Section titled “buffer?”Uint8Array<ArrayBufferLike>
an optional buffer to start with
length?
Section titled “length?”number = ...
an optional amount of bytes to use for the length.
Returns
Section titled “Returns”PipeArrayBuffer
Accessors
Section titled “Accessors”buffer
Section titled “buffer”Get Signature
Section titled “Get Signature”get buffer():
Uint8Array
Defined in: packages/candid/src/utils/buffer.ts:72
Returns
Section titled “Returns”Uint8Array
byteLength
Section titled “byteLength”Get Signature
Section titled “Get Signature”get byteLength():
number
Defined in: packages/candid/src/utils/buffer.ts:77
Returns
Section titled “Returns”number
Get Signature
Section titled “Get Signature”get end():
boolean
Defined in: packages/candid/src/utils/buffer.ts:127
Whether or not there is more data to read from the buffer
Returns
Section titled “Returns”boolean
Methods
Section titled “Methods”alloc()
Section titled “alloc()”alloc(
amount):void
Defined in: packages/candid/src/utils/buffer.ts:135
Allocate a fixed amount of memory in the buffer. This does not affect the view.
Parameters
Section titled “Parameters”amount
Section titled “amount”number
A number of bytes to add to the buffer.
Returns
Section titled “Returns”void
read()
Section titled “read()”read(
num):Uint8Array
Defined in: packages/candid/src/utils/buffer.ts:85
Read num number of bytes from the front of the pipe.
Parameters
Section titled “Parameters”number
The number of bytes to read.
Returns
Section titled “Returns”Uint8Array
readUint8()
Section titled “readUint8()”readUint8():
undefined|number
Defined in: packages/candid/src/utils/buffer.ts:91
Returns
Section titled “Returns”undefined | number
restore()
Section titled “restore()”restore(
checkPoint):void
Defined in: packages/candid/src/utils/buffer.ts:36
Restore a checkpoint of the reading view (for backtracking)
Parameters
Section titled “Parameters”checkPoint
Section titled “checkPoint”Uint8Array
a previously saved checkpoint
Returns
Section titled “Returns”void
save()
Section titled “save()”save():
Uint8Array
Defined in: packages/candid/src/utils/buffer.ts:28
Save a checkpoint of the reading view (for backtracking)
Returns
Section titled “Returns”Uint8Array
write()
Section titled “write()”write(
buf):void
Defined in: packages/candid/src/utils/buffer.ts:104
Write a buffer to the end of the pipe.
Parameters
Section titled “Parameters”Uint8Array
The bytes to write.
Returns
Section titled “Returns”void