Class FileWriteStream

Implementation of the stream that has access to the file and is optimized for fast writing to it.

Inheritance

Stream

WriteStream

FileWriteStream

Inherited Members

Stream::_hasError

Stream::CanRead()

WriteStream::CanWrite()

WriteStream::data

WriteStream::DEPRECATED("Use Write method") void WriteString(const StringView& data)

Stream::HasError()

WriteStream::lock

Stream::Stream()

WriteStream::useDouble

WriteStream::Write(const StringView& data)

WriteStream::Write(const StringView& data, int16 lock)

WriteStream::Write(const StringAnsiView& data)

WriteStream::Write(const StringAnsiView& data, int8 lock)

WriteStream::Write(const CommonValue& data)

WriteStream::Write(const VariantType& data)

WriteStream::Write(const Variant& data)

WriteStream::Write(const T& data)

WriteStream::Write(const T* data)

WriteStream::Write(const ScriptingObjectReference<T>& v)

WriteStream::Write(const SoftObjectReference<T>& v)

WriteStream::Write(const AssetReference<T>& v)

WriteStream::Write(const WeakAssetReference<T>& v)

WriteStream::Write(const SoftAssetReference<T>& v)

WriteStream::Write(const Span<T>& data)

WriteStream::Write(const Array<T, AllocationType>& data)

WriteStream::Write(const Dictionary<KeyType, ValueType, AllocationType>& data)

WriteStream::Write(const BoundingBox& box, bool useDouble=false)

WriteStream::Write(const BoundingSphere& sphere, bool useDouble=false)

WriteStream::Write(const Transform& transform, bool useDouble=false)

WriteStream::Write(const Ray& ray, bool useDouble=false)

WriteStream::WriteBOM()

WriteStream::WriteBool(bool data)

WriteStream::WriteByte(byte data)

WriteStream::WriteChar(char data)

WriteStream::WriteChar(Char data)

WriteStream::WriteDouble(double data)

WriteStream::WriteFloat(float data)

WriteStream::WriteInt16(int16 data)

WriteStream::WriteInt32(int32 data)

WriteStream::WriteInt64(int64 data)

WriteStream::WriteInt8(int8 data)

WriteStream::WriteJson(ISerializable* obj, const void* otherObj=nullptr)

WriteStream::WriteJson(const StringAnsiView& json)

WriteStream::WriteText(const char* text, int32 length)

WriteStream::WriteText(const Char* text, int32 length)

WriteStream::WriteText(const StringView& text)

WriteStream::WriteText(const StringAnsiView& text)

WriteStream::WriteUint16(uint16 data)

WriteStream::WriteUint32(uint32 data)

WriteStream::WriteUint64(uint64 data)

WriteStream::WriteUint8(uint8 data)

Stream::~Stream()

Assembly: FlaxEngine.dll

File: Engine/Serialization/FileWriteStream.h

Syntax

public class FileWriteStream : public WriteStream

Constructors

~FileWriteStream()

Destructor

Declaration

public ~FileWriteStream()

FileWriteStream(File* file)

Init

Declaration

public FileWriteStream(File* file)

Parameters

File file File to write

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 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 read data from it

Declaration

public static FileWriteStream* Open(const StringView& path)

Parameters

StringView path Path to the file

Returns

FileWriteStream Created file writer stream or null if cannot perform it

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()

WriteBytes(const void* data, uint32 bytes)

Writes bytes to the stream.

Declaration

public virtual void WriteBytes(const void* data, uint32 bytes) override

Parameters

void data Pointer to data to write.

uint32 bytes Amount of bytes to write.

Overrides

WriteStream::WriteBytes(const void* data, uint32 bytes)

See Also

WriteStream