Skip to content
Download
API reference

StreamPeerBuffer

Inherits: StreamPeer < Shared < Object

A stream peer used to handle binary data streams.

A data buffer stream peer that uses a byte array as the stream. This object can be used to handle binary data from network sessions. To handle binary data stored in files, FileAccess can be used directly.

A StreamPeerBuffer object keeps an internal cursor which is the offset in bytes to the start of the buffer. Get and put operations are performed at the cursor position and will move the cursor accordingly.

TypeNameDefault
[]u8data_arrayPackedByteArray()
ReturnsMethod
voidclear()
StreamPeerBufferduplicate()
intget_position()
intget_size()
voidresize(size)
voidseek(position)

[]u8 data_array = PackedByteArray()

Setter/getter: set_data_array(), get_data_array()

The underlying data buffer. Setting this value resets the cursor.

void clear()

Clears the data_array and resets the cursor.

StreamPeerBuffer duplicate() const

Returns a new StreamPeerBuffer with the same data_array content.

int get_position() const

Returns the current cursor position.

int get_size() const

Returns the size of data_array.

void resize(size: int)

Resizes the data_array. This doesn’t update the cursor.

void seek(position: int)

Moves the cursor to the specified position. position must be a valid index of data_array.