gf::FileInputStream Class Reference

File based input stream. More...

#include <gf/Streams.h>

Inheritance diagram for gf::FileInputStream:

Public Member Functions
	FileInputStream (const Path &path)
	Constructor. More...
	~FileInputStream ()
	Destructor. More...
std::size_t	read (Span< uint8_t > buffer) override
	Read data from the stream. More...
void	seek (std::ptrdiff_t position) override
	Change the current reading position. More...
void	skip (std::ptrdiff_t position) override
	Change the current reading position. More...
bool	isFinished () override
	Tell if the stream is at the end. More...
Public Member Functions inherited from gf::InputStream
	InputStream ()=default
	Default constructor. More...
	InputStream (const InputStream &)=delete
	Deleted copy constructor. More...
InputStream &	operator= (const InputStream &)=delete
	Deleted copy assignment. More...
virtual	~InputStream ()
	Destructor. More...
virtual std::size_t	read (Span< uint8_t > buffer)=0
	Read data from the stream. More...
std::size_t	read (uint8_t &byte)
	Read a single byte from the stream. More...
virtual void	seek (std::ptrdiff_t position)=0
	Change the current reading position. More...
virtual void	skip (std::ptrdiff_t position)=0
	Change the current reading position. More...
virtual bool	isFinished ()=0
	Tell if the stream is at the end. More...

Detailed Description

File based input stream.

Constructor & Destructor Documentation

FileInputStream()

gf::FileInputStream::FileInputStream ( const Path &  path )

explicit

Constructor.

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

Parameters

path	The path to the file

~FileInputStream()

gf::FileInputStream::~FileInputStream

(

)

Destructor.

The destructor closes the file.

Member Function Documentation

isFinished()

bool gf::FileInputStream::isFinished ( )

overridevirtual

Tell if the stream is at the end.

Returns

A boolean indicating the end of the stream

Implements gf::InputStream.

read()

std::size_t gf::FileInputStream::read ( Span< uint8_t >  buffer )

overridevirtual

Read data from the stream.

After reading, the stream's reading position must be advanced by the amount of bytes read.

Parameters

buffer

The buffer where to copy the read data

Returns

The number of bytes actually read

Implements gf::InputStream.

seek()

void gf::FileInputStream::seek ( std::ptrdiff_t  position )

overridevirtual

Change the current reading position.

Parameters

position

The position to seek to, from the beginning

Implements gf::InputStream.

skip()

void gf::FileInputStream::skip ( std::ptrdiff_t  position )

overridevirtual

Change the current reading position.

Parameters

position

The position to seek to, from the current position

Implements gf::InputStream.