File based output stream. More...

#include <gf/Streams.h>

Inheritance diagram for gf::FileOutputStream:

Public Types
enum class	Mode { Write , Append }
	Open mode for the file. More...

Public Member Functions
	FileOutputStream (const Path &path, Mode mode=Mode::Write)
	Constructor. More...

	~FileOutputStream ()
	Destructor. More...

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

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

Public Member Functions inherited from gf::OutputStream
	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

File based output stream.

Member Enumeration Documentation

◆ Mode

enum class gf::FileOutputStream::Mode

strong

Open mode for the file.

Enumerator
Write	Open the file in write only mode.
Append	Open the file in append only mode.

Constructor & Destructor Documentation

◆ FileOutputStream()

gf::FileOutputStream::FileOutputStream	(	const Path &	path,
		Mode	mode = `Mode::Write`
	)

Constructor.

The constructor opens the file. If the file is not opened, an exception is thrown.

Parameters

path	The path to the file
mode	The open mode of the file

◆ ~FileOutputStream()

gf::FileOutputStream::~FileOutputStream ( )

Destructor.

The destructor closes the file.

Member Function Documentation

◆ getWrittenBytesCount()

std::size_t gf::FileOutputStream::getWrittenBytesCount ( ) const

overridevirtual

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

Implements gf::OutputStream.

◆ write()

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