Class ReadStream

Base class for all data read streams

Inheritance

Stream

ReadStream

Inherited Members

Stream::_hasError

Stream::CanWrite()

Stream::Close()

Stream::Flush()

Stream::GetLength()

Stream::GetPosition()

Stream::HasError()

Stream::SetPosition(uint32 seek)

Stream::Stream()

Stream::~Stream()

Assembly: FlaxEngine.dll

File: Engine/Serialization/ReadStream.h

Syntax

public class ReadStream : public Stream

Constructors

DEPRECATED("Use Read method") void ReadStringAnsi(StringAnsi* data)

[Deprecated on 11.10.2022, expires on 11.10.2024]

Declaration

public DEPRECATED("Use Read method") void ReadStringAnsi(StringAnsi* data)

Parameters

"Use Read method" ReadStream_DEPRECATED__Use_Read_method__

Fields

data

Declaration

public AllocationType* data{
    Read(*data)

Field Value

AllocationType

lock

Declaration

public int8 lock

Field Value

int8

useDouble

Declaration

public bool useDouble = false)

Field Value

bool

Methods

CanRead()

Returns true if can read data from that stream.

Declaration

public virtual bool CanRead() override

Returns

bool True if can read, otherwise false.

Overrides

Stream::CanRead()

Read(Array<T, AllocationType>& data)

Reads array.

Declaration

public void Read(Array<T, AllocationType>& data)

Parameters

Array<T, AllocationType> data Array to read.

Type Parameters

typename T

typename AllocationType

Read(AssetReference<T>& v)

Declaration

public void Read(AssetReference<T>& v)

Parameters

AssetReference<T> v

Returns

void

Type Parameters

typename T

Read(BoundingBox& box, bool useDouble=false)

Declaration

public void Read(BoundingBox& box, bool useDouble=false)

Parameters

BoundingBox box

bool useDouble

Read(BoundingSphere& sphere, bool useDouble=false)

Declaration

public void Read(BoundingSphere& sphere, bool useDouble=false)

Parameters

BoundingSphere sphere

bool useDouble

Read(CommonValue& data)

Declaration

public void Read(CommonValue& data)

Parameters

CommonValue data

Read(Dictionary<KeyType, ValueType, AllocationType>& data)

Reads dictionary.

Declaration

public void Read(Dictionary<KeyType, ValueType, AllocationType>& data)

Parameters

Dictionary<KeyType, ValueType, AllocationType> data Dictionary to read.

Type Parameters

typename KeyType

typename ValueType

typename AllocationType

Read(Ray& ray, bool useDouble=false)

Declaration

public void Read(Ray& ray, bool useDouble=false)

Parameters

Ray ray

bool useDouble

Read(ScriptingObjectReference<T>& v)

Declaration

public void Read(ScriptingObjectReference<T>& v)

Parameters

ScriptingObjectReference<T> v

Returns

void

Type Parameters

typename T

Read(SoftAssetReference<T>& v)

Declaration

public void Read(SoftAssetReference<T>& v)

Parameters

SoftAssetReference<T> v

Returns

void

Type Parameters

typename T

Read(SoftObjectReference<T>& v)

Declaration

public void Read(SoftObjectReference<T>& v)

Parameters

SoftObjectReference<T> v

Returns

void

Type Parameters

typename T

Read(String& data)

Declaration

public void Read(String& data)

Parameters

String data

Read(String& data, int16 lock)

Declaration

public void Read(String& data, int16 lock)

Parameters

String data

int16 lock

Read(StringAnsi& data)

Declaration

public void Read(StringAnsi& data)

Parameters

StringAnsi data

Read(StringAnsi& data, int8 lock)

Declaration

public void Read(StringAnsi& data, int8 lock)

Parameters

StringAnsi data

int8 lock

Read(T& data)

Declaration

public TEnableIf<TIsPODType<T>::Value>::Type Read(T& data)

Parameters

T data

Returns

TEnableIf<TIsPODType<T>::Value>::Type

Type Parameters

typename T

Read(T*& data)

Declaration

public TEnableIf<TIsBaseOf<ScriptingObject, T>::Value>::Type Read(T*& data)

Parameters

T data

Returns

TEnableIf<TIsBaseOf<ScriptingObject, T>::Value>::Type

Type Parameters

typename T

Read(Transform& transform, bool useDouble=false)

Declaration

public void Read(Transform& transform, bool useDouble=false)

Parameters

Transform transform

bool useDouble

Read(Variant& data)

Declaration

public void Read(Variant& data)

Parameters

Variant data

Read(VariantType& data)

Declaration

public void Read(VariantType& data)

Parameters

VariantType data

Read(WeakAssetReference<T>& v)

Declaration

public void Read(WeakAssetReference<T>& v)

Parameters

WeakAssetReference<T> v

Returns

void

Type Parameters

typename T

ReadBool()

Declaration

public bool ReadBool()

Returns

bool

ReadByte()

Declaration

public byte ReadByte()

Returns

byte

ReadByte(byte* data)

Declaration

public void ReadByte(byte* data)

Parameters

byte data

Returns

void

ReadBytes(void* data, uint32 bytes)

Reads bytes from the stream

Declaration

public virtual void ReadBytes(void* data, uint32 bytes) = 0

Parameters

void data Data to read

uint32 bytes Amount of bytes to read

ReadChar()

Declaration

public char ReadChar()

Returns

char

ReadChar(Char* data)

Declaration

public void ReadChar(Char* data)

Parameters

Char data

Returns

void

ReadDouble(double* data)

Declaration

public void ReadDouble(double* data)

Parameters

double data

Returns

void

ReadFloat(float* data)

Declaration

public void ReadFloat(float* data)

Parameters

float data

Returns

void

ReadInt16(int16* data)

Declaration

public void ReadInt16(int16* data)

Parameters

int16 data

Returns

void

ReadInt32(int32* data)

Declaration

public void ReadInt32(int32* data)

Parameters

int32 data

Returns

void

ReadInt64(int64* data)

Declaration

public void ReadInt64(int64* data)

Parameters

int64 data

Returns

void

ReadInt8(int8* data)

Declaration

public void ReadInt8(int8* data)

Parameters

int8 data

Returns

void

ReadJson(ISerializable* obj)

Deserializes object from Json by reading it as a raw data (ver+length+bytes).

Reads version number, data length and actual data bytes from the stream.

Declaration

public void ReadJson(ISerializable* obj)

Parameters

ISerializable obj The object to deserialize.

ReadUint16(uint16* data)

Declaration

public void ReadUint16(uint16* data)

Parameters

uint16 data

Returns

void

ReadUint32(uint32* data)

Declaration

public void ReadUint32(uint32* data)

Parameters

uint32 data

Returns

void

ReadUint64(uint64* data)

Declaration

public void ReadUint64(uint64* data)

Parameters

uint64 data

Returns

void

ReadUint8(uint8* data)

Declaration

public void ReadUint8(uint8* data)

Parameters

uint8 data

Returns

void