OpenTTD Source: FileReader Struct Reference

OpenTTD Source 14.0-beta3

Public Member Functions | Data Fields
FileReader Struct Reference

Yes, simply reading from a file. More...

Inheritance diagram for FileReader:

## Public Member Functions
| FileReader (FILE *file)
| Create the file reader, so it reads from a specific file. More...
| ~FileReader ()
| Make sure everything is cleaned up.
size_t | Read (byte *buf, size_t size) override
| Read a given number of bytes from the savegame. More...
void | Reset () override
| Reset this filter to read from the beginning of the file.
Public Member Functions inherited from LoadFilter
| LoadFilter (std::shared_ptr< LoadFilter > chain)
| Initialise this filter. More...
virtual | ~LoadFilter ()
| Make sure the writers are properly closed.

## Data Fields
FILE * | file
| The file to read from.
long | begin
| The begin of the file.
Data Fields inherited from LoadFilter
std::shared_ptr< LoadFilter > | chain
| Chained to the (savegame) filters.

## Detailed Description

Yes, simply reading from a file.

Definition at line 2161 of file saveload.cpp.

## Constructor & Destructor Documentation

## ◆ FileReader()

FileReader::FileReader | ( | FILE * | file | ) |
| inline

Create the file reader, so it reads from a specific file.

Parameters

  file | The file to read from.

Definition at line 2169 of file saveload.cpp.

## Member Function Documentation

## ◆ Read()

size_t FileReader::Read | ( | byte * | buf,
|  | size_t | len
| ) |  |
| inlineoverridevirtual

Read a given number of bytes from the savegame.

Parameters

  buf | The bytes to read.
  len | The number of bytes to read.

Returns
  The number of actually read bytes.

Implements LoadFilter.

Definition at line 2180 of file saveload.cpp.

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

- src/saveload/saveload.cpp