StreamPeerBuffer
A stream peer used to handle binary data streams.
StreamPeerBuffer.swift:20class StreamPeerBuffer
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.
Superclasses
class StreamPeer
Abstract base class for interacting with streams.
Citizens in SwiftGodot
Conformances
protocol CustomStringConvertible
A type with a customized textual representation.
protocol Equatable
A type that can be compared for value equality.
protocol Hashable
A type that can be hashed into a
Hasher
to produce an integer hash value.protocol Identifiable<ID>
A class of types whose instances hold the value of an entity with stable identity.
protocol VariantRepresentable
Types that conform to VariantRepresentable can be stored directly in
Variant
with no conversion. These include all of the Variant types from Godot (for exampleGString
,Rect
,Plane
), Godot objects (those that subclass SwiftGodot.Object) as well as the built-in Swift types UInt8, Int64 and Double.protocol VariantStorable
Types that conform to VariantStorable can be stored in a Variant and can be extracted back out of a Variant.
Type members
Instance members
var dataArray: PackedByteArray
The underlying data buffer. Setting this value resets the cursor.
func clear(
) Clears the
dataArray
and resets the cursor.func duplicate(
) -> StreamPeerBuffer? Returns a new
StreamPeerBuffer
with the samedataArray
content.func getPosition(
) -> Int32 Returns the current cursor position.
func getSize(
) -> Int32 Returns the size of
dataArray
.func resize(size: Int32
) Resizes the
dataArray
. This doesn’t update the cursor.func seek(position: Int32
) Moves the cursor to the specified position.
position
must be a valid index ofdataArray
.