Abstract class for custom file output streams. More...

#include <gf/Stream.h>

Inheritance diagram for gf::OutputStream:

[legend]

Public Member Functions
	OutputStream ()=default
	Default constructor. More...

	OutputStream (const OutputStream &)=delete
	Deleted copy constructor. More...

OutputStream &	operator= (const OutputStream &)=delete
	Deleted copy assignment. More...

virtual	~OutputStream ()
	Destructor. More...

virtual std::size_t	write (Span< const uint8_t > buffer)=0
	Write data to the stream. More...

std::size_t	write (uint8_t byte)
	Write a single byte to the stream. More...

virtual std::size_t	getWrittenBytesCount () const =0
	Get the number of bytes already written. More...

Detailed Description

Abstract class for custom file output streams.

This class allows users to define their own stream output sinks to which Gamedev Framework can save resources.

See also: gf::InputStream

Constructor & Destructor Documentation

◆ OutputStream() [1/2]

gf::OutputStream::OutputStream ( )

default

Default constructor.

◆ OutputStream() [2/2]

gf::OutputStream::OutputStream ( const OutputStream & )

delete

Deleted copy constructor.

◆ ~OutputStream()

virtual gf::OutputStream::~OutputStream ( )

virtual

Destructor.

Member Function Documentation

◆ getWrittenBytesCount()

virtual std::size_t gf::OutputStream::getWrittenBytesCount ( ) const

pure virtual

Get the number of bytes already written.

This function returns the number of bytes actually written i.e. it does not take into account possible bytes that have not been flushed yet.

Returns: The number of written bytes

Implemented in gf::FileOutputStream, gf::MemoryOutputStream, gf::CompressedOutputStream, and gf::BufferOutputStream.

◆ operator=()

OutputStream & gf::OutputStream::operator= ( const OutputStream & )

delete

Deleted copy assignment.

◆ write() [1/2]

virtual std::size_t gf::OutputStream::write ( Span< const uint8_t > buffer )

pure virtual

Write data to the stream.

Parameters

buffer The buffer to copy to the stream

Returns: The number of bytes actually written