OpenTTD Source 20241224-master-gf74b0cf984
LZMALoadFilter Struct Reference

Filter without any compression. More...

Inheritance diagram for LZMALoadFilter:
LoadFilter

Public Member Functions

 LZMALoadFilter (std::shared_ptr< LoadFilter > chain)
 Initialise this filter.
 
 ~LZMALoadFilter ()
 Clean everything up.
 
size_t Read (uint8_t *buf, size_t size) override
 Read a given number of bytes from the savegame.
 
- Public Member Functions inherited from LoadFilter
 LoadFilter (std::shared_ptr< LoadFilter > chain)
 Initialise this filter.
 
virtual ~LoadFilter ()=default
 Make sure the writers are properly closed.
 
virtual void Reset ()
 Reset this filter to read from the beginning of the file.
 

Data Fields

lzma_stream lzma
 Stream state that we are reading from.
 
uint8_t fread_buf [MEMORY_CHUNK_SIZE]
 Buffer for reading from the file.
 
- Data Fields inherited from LoadFilter
std::shared_ptr< LoadFilterchain
 Chained to the (savegame) filters.
 

Detailed Description

Filter without any compression.

Definition at line 2580 of file saveload.cpp.

Constructor & Destructor Documentation

◆ LZMALoadFilter()

LZMALoadFilter::LZMALoadFilter ( std::shared_ptr< LoadFilter chain)
inline

Initialise this filter.

Parameters
chainThe next filter in this chain.

Definition at line 2588 of file saveload.cpp.

References SlError().

◆ ~LZMALoadFilter()

LZMALoadFilter::~LZMALoadFilter ( )
inline

Clean everything up.

Definition at line 2595 of file saveload.cpp.

Member Function Documentation

◆ Read()

size_t LZMALoadFilter::Read ( uint8_t *  buf,
size_t  len 
)
inlineoverridevirtual

Read a given number of bytes from the savegame.

Parameters
bufThe bytes to read.
lenThe number of bytes to read.
Returns
The number of actually read bytes.

Implements LoadFilter.

Definition at line 2600 of file saveload.cpp.

References LoadFilter::chain, fread_buf, and SlError().

Field Documentation

◆ fread_buf

uint8_t LZMALoadFilter::fread_buf[MEMORY_CHUNK_SIZE]

Buffer for reading from the file.

Definition at line 2582 of file saveload.cpp.

Referenced by Read().

◆ lzma

lzma_stream LZMALoadFilter::lzma

Stream state that we are reading from.

Definition at line 2581 of file saveload.cpp.


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