Class FileReadStream

Implementation of the stream that has access to the file and is optimized for fast reading from it

Inheritance

Stream

ReadStream

FileReadStream

Inherited Members

Stream::_hasError

ReadStream::CanRead()

Stream::CanWrite()

ReadStream::data

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

Stream::HasError()

ReadStream::lock

ReadStream::Read(String& data)

ReadStream::Read(String& data, int16 lock)

ReadStream::Read(StringAnsi& data)

ReadStream::Read(StringAnsi& data, int8 lock)

ReadStream::Read(CommonValue& data)

ReadStream::Read(VariantType& data)

ReadStream::Read(Variant& data)

ReadStream::Read(T& data)

ReadStream::Read(T*& data)

ReadStream::Read(ScriptingObjectReference<T>& v)

ReadStream::Read(SoftObjectReference<T>& v)

ReadStream::Read(AssetReference<T>& v)

ReadStream::Read(WeakAssetReference<T>& v)

ReadStream::Read(SoftAssetReference<T>& v)

ReadStream::Read(Array<T, AllocationType>& data)

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

ReadStream::Read(BoundingBox& box, bool useDouble=false)

ReadStream::Read(BoundingSphere& sphere, bool useDouble=false)

ReadStream::Read(Transform& transform, bool useDouble=false)

ReadStream::Read(Ray& ray, bool useDouble=false)

ReadStream::ReadBool()

ReadStream::ReadByte()

ReadStream::ReadByte(byte* data)

ReadStream::ReadChar()

ReadStream::ReadChar(Char* data)

ReadStream::ReadDouble(double* data)

ReadStream::ReadFloat(float* data)

ReadStream::ReadInt16(int16* data)

ReadStream::ReadInt32(int32* data)

ReadStream::ReadInt64(int64* data)

ReadStream::ReadInt8(int8* data)

ReadStream::ReadJson(ISerializable* obj)

ReadStream::ReadUint16(uint16* data)

ReadStream::ReadUint32(uint32* data)

ReadStream::ReadUint64(uint64* data)

ReadStream::ReadUint8(uint8* data)

Stream::Stream()

ReadStream::useDouble

Stream::~Stream()

Assembly: FlaxEngine.dll

File: Engine/Serialization/FileReadStream.h

Syntax

public class FileReadStream : public ReadStream

Constructors

~FileReadStream()

Destructor

Declaration

public ~FileReadStream()

FileReadStream(File* file)

Init

Declaration

public FileReadStream(File* file)

Parameters

File file File to read

Methods

Close()

Close the stream

Declaration

public virtual void Close() final override

Overrides

Stream::Close()

Flush()

Flush the stream buffers

Declaration

public virtual void Flush() final override

Overrides

Stream::Flush()

GetFile()

Gets the file handle.

Declaration

public File* GetFile() const

Returns

File

GetLength()

Gets length of the stream

Declaration

public virtual uint32 GetLength() override

Returns

uint32 Length of the stream

Overrides

Stream::GetLength()

GetPosition()

Gets current position in the stream

Declaration

public virtual uint32 GetPosition() override

Returns

uint32 Current position in the stream

Overrides

Stream::GetPosition()

Open(const StringView& path)

Open file to write data to it

Declaration

public static FileReadStream* Open(const StringView& path)

Parameters

StringView path Path to the file

Returns

FileReadStream Created file reader stream or null if cannot perform that action

ReadBytes(void* data, uint32 bytes)

Reads bytes from the stream

Declaration

public virtual void ReadBytes(void* data, uint32 bytes) override

Parameters

void data Data to read

uint32 bytes Amount of bytes to read

Overrides

ReadStream::ReadBytes(void* data, uint32 bytes)

SetPosition(uint32 seek)

Set new position in the stream

Declaration

public virtual void SetPosition(uint32 seek) override

Parameters

uint32 seek New position in the stream

Overrides

Stream::SetPosition(uint32 seek)

Unlink()

Unlink file object passed via constructor

Declaration

public void Unlink()

See Also

ReadStream