Interface for filtering a savegame till it is written. More...

#include <saveload_filter.h>

Inheritance diagram for SaveFilter:

Public Member Functions
	SaveFilter (std::shared_ptr< SaveFilter > chain)
	Initialise this filter.
virtual	~SaveFilter ()=default
	Make sure the writers are properly closed.
virtual void	Write (uint8_t *buf, size_t len)=0
	Write a given number of bytes into the savegame.
virtual void	Finish ()
	Prepare everything to finish writing the savegame.

Data Fields
std::shared_ptr< SaveFilter >	chain
	Chained to the (savegame) filters.

Detailed Description

Interface for filtering a savegame till it is written.

Definition at line 57 of file saveload_filter.h.

Constructor & Destructor Documentation

◆ SaveFilter()

SaveFilter::SaveFilter ( std::shared_ptr< SaveFilter > chain )

inline

Initialise this filter.

Parameters

chain The next filter in this chain.

Definition at line 65 of file saveload_filter.h.

References chain.

Referenced by FileWriter::FileWriter(), LZMASaveFilter::LZMASaveFilter(), LZOSaveFilter::LZOSaveFilter(), NoCompSaveFilter::NoCompSaveFilter(), PacketWriter::PacketWriter(), and ZlibSaveFilter::ZlibSaveFilter().

Member Function Documentation

◆ Finish()

virtual void SaveFilter::Finish ( )

inlinevirtual

Prepare everything to finish writing the savegame.

Reimplemented in FileWriter, LZMASaveFilter, PacketWriter, and ZlibSaveFilter.

Definition at line 82 of file saveload_filter.h.

◆ Write()

virtual void SaveFilter::Write	(	uint8_t *	buf,
		size_t	len )

pure virtual

Write a given number of bytes into the savegame.

Parameters

buf	The bytes to write.
len	The number of bytes to write.

Implemented in FileWriter, LZMASaveFilter, LZOSaveFilter, NoCompSaveFilter, PacketWriter, and ZlibSaveFilter.

Field Documentation

◆ chain

std::shared_ptr<SaveFilter> SaveFilter::chain

Chained to the (savegame) filters.

Definition at line 59 of file saveload_filter.h.

Referenced by LZMASaveFilter::Finish(), ZlibSaveFilter::Finish(), LZMASaveFilter::LZMASaveFilter(), LZOSaveFilter::LZOSaveFilter(), NoCompSaveFilter::NoCompSaveFilter(), SaveFilter(), LZOSaveFilter::Write(), NoCompSaveFilter::Write(), LZMASaveFilter::WriteLoop(), ZlibSaveFilter::WriteLoop(), and ZlibSaveFilter::ZlibSaveFilter().

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

src/saveload/saveload_filter.h

Public Member Functions

Data Fields