Base for dballe::File implementations. More...

#include <file.h>

Inheritance diagram for dballe::core::File:

Public Member Functions
	File (const std::string &name, FILE *fd, bool close_on_exit=true)

std::string	pathname () const override
	Get the file pathname.

bool	foreach (std::function< bool(const BinaryMessage &)> dest) override
	Read all the messages from the file, calling the function on each of them. More...

Public Member Functions inherited from dballe::File
virtual Encoding	encoding () const =0
	Get the file encoding.

virtual BinaryMessage	read ()=0
	Read a message from the file. More...

virtual void	write (const std::string &msg)=0
	Append the binary message to the file.

Static Public Member Functions
static std::string	resolve_test_data_file (const std::string &name)
	Resolve the location of a test data file. More...

static std::unique_ptr< dballe::File >	open_test_data_file (Encoding type, const std::string &name)
	Open a test data file. More...

Static Public Member Functions inherited from dballe::File
static std::unique_ptr< File >	create (const std::string &pathname, const char *mode)
	Open a file from the filesystem, autodetecting the encoding type. More...

static std::unique_ptr< File >	create (Encoding type, const std::string &pathname, const char *mode)
	Open a file from the filesystem. More...

static std::unique_ptr< File >	create (FILE *file, bool close_on_exit, const std::string &name="(fp)")
	Create a File from an existing FILE* stream, autodetecting the encoding type. More...

static std::unique_ptr< File >	create (Encoding type, FILE *file, bool close_on_exit, const std::string &name="(fp)")
	Create a File from an existing FILE* stream. More...

static const char *	encoding_name (Encoding enc)
	Return a string with the name of this encoding.

static Encoding	parse_encoding (const char *s)
	Return the Encoding corresponding to the given name.

static Encoding	parse_encoding (const std::string &s)
	Return the Encoding corresponding to the given name.

Protected Attributes
std::string	m_name
	Name of the file.

FILE *	fd
	FILE structure used to read or write to the file.

bool	close_on_exit
	True if fd should be closed on destruction.

int	idx
	Index of the last message read from the file or written to the file.

Additional Inherited Members
Public Types inherited from dballe::File
enum	Encoding { BUFR = 0, CREX = 1, AOF = 2 }
	Supported encodings.

Detailed Description

Base for dballe::File implementations.

Member Function Documentation

bool dballe::core::File::foreach ( std::function< bool(const BinaryMessage &)> dest )

overridevirtual

Read all the messages from the file, calling the function on each of them.

If dest returns false, reading will stop.

Returns: true if all file was read, false if reading was stopped because dest returned false.

static std::unique_ptr<dballe::File> dballe::core::File::open_test_data_file	(	Encoding	type,
		const std::string &	name
	)

static

Open a test data file.

This should only be used during dballe unit tests.

static std::string dballe::core::File::resolve_test_data_file ( const std::string & name )

static

Resolve the location of a test data file.

This should only be used during dballe unit tests.

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