CeresEngine::BufferedOutputStream Class Reference

A filtered OutputStream that caches read and write operations to it's underlying OutputStream. More...

#include <CeresEngine/Foundation/IO/Stream.Buffered.hpp>

Inheritance diagram for CeresEngine::BufferedOutputStream:

Public Member Functions
	BufferedOutputStream (OutputStream &&outputStream, size_t bufferSize=1024)
	Creates a new buffer data stream.
	BufferedOutputStream (const BufferedOutputStream &)=delete
	BufferedOutputStream (BufferedOutputStream &&) noexcept
	~BufferedOutputStream () final
	Destroys the buffered data stream.
void	seek (std::streamsize position, Seek mode=Seek::Start) final
	Changes the position of the data stream.
size_t	tell () final
	Gets the absolute stream position, in bytes.
size_t	write (const void *data, size_t n) final
	Writes data to the data stream from a buffer of raw memory data with length n.
bool	flush () final
	In the stream is buffered, invalidates any buffered write data from to stream.
Public Member Functions inherited from CeresEngine::FilteredOutputStream
	FilteredOutputStream (OutputStream &&outputStream)
	Creates a new filtered data stream.
	FilteredOutputStream (FilteredOutputStream &&) noexcept=default
	~FilteredOutputStream () override=default
OutputStream &	getOutputStream () noexcept
	The data stream being filtered.
const OutputStream &	getOutputStream () const noexcept
	The data stream being filtered.
bool	isSeekable (const Seek mode=Seek::Start) const noexcept override
	Checks if the stream is seekable.
void	seek (const std::streamsize position, const Seek mode=Seek::Start) override
	Changes the position of the data stream.
bool	isTellable () const noexcept override
	Checks if the stream knows it's current absolute position.
size_t	tell () override
	Gets the absolute stream position, in bytes.
bool	isSizeKnown () const noexcept override
	Checks if the stream knows the size of the data.
size_t	size () override
	Gets the number of bytes available on the stream.
bool	isWritable () const noexcept override
	Checks if the stream is writable.
size_t	write (const void *data, const size_t n) override
	Writes data to the data stream from a buffer of raw memory data with length n.
bool	flush () override
	In the stream is buffered, invalidates any buffered write data from to stream.
virtual size_t	write (const void *data, size_t n)
	Writes data to the data stream from a buffer of raw memory data with length n.
template<typename T >
size_t	write (const MemoryView< const T > &memoryView)
	Writes data from a memory view to the stream.
template<typename T >
size_t	write (const StridedMemoryView< const T > &memoryView)
	Writes data from a strided memory view to the stream.
template<typename T > requires std::is_trivially_copyable_v<T>
bool	write (T value)
	Writes a trivially copyable object to the stream.
Public Member Functions inherited from CeresEngine::IOutputStream
template<typename T >
size_t	write (const MemoryView< const T > &memoryView)
	Writes data from a memory view to the stream.
template<typename T >
size_t	write (const StridedMemoryView< const T > &memoryView)
	Writes data from a strided memory view to the stream.
size_t	writeString (const StringView string)
	Writes a string to the data stream.
template<typename T > requires std::is_trivially_copyable_v<T>
bool	write (T value)
	Writes a trivially copyable object to the stream.
Public Member Functions inherited from CeresEngine::IStream
	IStream ()=default
	IStream (const IStream &) noexcept=delete
IStream &	operator= (const IStream &) noexcept=delete
	IStream (IStream &&) noexcept=default
IStream &	operator= (IStream &&) noexcept=default
virtual	~IStream () noexcept=default
void	skip (const size_t n)
	Skips n bytes from the data stream.

Private Types
using	super = FilteredOutputStream

Private Member Functions
void	flushWriteBuffer ()

Private Attributes
ByteMemoryView	mBuffer
size_t	mBufferPosition

Additional Inherited Members
Public Types inherited from CeresEngine::IStream
enum class	Seek { Start = SEEK_SET , Current = SEEK_CUR , End = SEEK_END }
	An enumeration that describes how a data stream should be seeked. More...
Protected Attributes inherited from CeresEngine::FilteredOutputStream
OutputStream	mOutputStream
	The data stream being filtered.

Detailed Description

A filtered OutputStream that caches read and write operations to it's underlying OutputStream.

Member Typedef Documentation

super

using CeresEngine::BufferedOutputStream::super = FilteredOutputStream

private

Constructor & Destructor Documentation

BufferedOutputStream() [1/3]

CeresEngine::BufferedOutputStream::BufferedOutputStream ( OutputStream &&  outputStream, size_t  bufferSize = 1024  )

explicit

Creates a new buffer data stream.

Parameters

bufferSize

Size of the memory chunk in bytes.

BufferedOutputStream() [2/3]

CeresEngine::BufferedOutputStream::BufferedOutputStream ( const BufferedOutputStream &  )

delete

BufferedOutputStream() [3/3]

CeresEngine::BufferedOutputStream::BufferedOutputStream ( BufferedOutputStream &&  )

noexcept

~BufferedOutputStream()

CeresEngine::BufferedOutputStream::~BufferedOutputStream ( )

final

Destroys the buffered data stream.

Member Function Documentation

flush()

bool CeresEngine::BufferedOutputStream::flush ( )

finalvirtual

In the stream is buffered, invalidates any buffered write data from to stream.

Non-buffered streams are free to ignore this method.

Returns

True if the flushing finished successfully; false otherwise.

Reimplemented from CeresEngine::IOutputStream.

flushWriteBuffer()

void CeresEngine::BufferedOutputStream::flushWriteBuffer ( )

private

seek()

void CeresEngine::BufferedOutputStream::seek ( std::streamsize  position, Seek  mode = Seek::Start  )

finalvirtual

Changes the position of the data stream.

Note

This method is only callable if isSeekable() returns true.

Parameters

position	The position to set the data stream to.
mode	The mode to change the data stream position.

Reimplemented from CeresEngine::IStream.

tell()

size_t CeresEngine::BufferedOutputStream::tell ( )

finalvirtual

Gets the absolute stream position, in bytes.

Note

This method is only callable if isTellable() returns true.

Reimplemented from CeresEngine::IStream.

write()

size_t CeresEngine::BufferedOutputStream::write ( const void *  data, size_t  n  )

finalvirtual

Writes data to the data stream from a buffer of raw memory data with length n.

Note

This method is only callable if isWritable() returns true.

Parameters

data	The memory location to which written data should be copied from.
n	The maximum number of bytes to be write to the data stream.

Returns

The number of bytes actually written. Can be smaller than n, in that case the write operation must be repeated to ensure that all data was written. If 0, indicates that the stream has ended.

Reimplemented from CeresEngine::IOutputStream.

Member Data Documentation

mBuffer

ByteMemoryView CeresEngine::BufferedOutputStream::mBuffer

private

mBufferPosition

size_t CeresEngine::BufferedOutputStream::mBufferPosition

private

---

The documentation for this class was generated from the following file:

• /Users/Rogiel/Developer/CeresEngine/Engine/Sources/CeresEngine/Foundation/IO/Stream.Buffered.hpp