Ninja
Public Types | Public Member Functions | List of all members
FileReader Struct Referenceabstract

Interface for reading files from disk. More...

#include <disk_interface.h>

Inheritance diagram for FileReader:
Inheritance graph
[legend]

Public Types

enum  Status { Okay , NotFound , OtherError }
 Result of ReadFile. More...
 

Public Member Functions

virtual Status ReadFile (const std::string &path, std::string *contents, std::string *err)=0
 Read and store in given string. More...
 
virtual ~FileReader ()
 

Detailed Description

Interface for reading files from disk.

See DiskInterface for details. This base offers the minimum interface needed just to read files.

Definition at line 25 of file disk_interface.h.

Member Enumeration Documentation

◆ Status

Result of ReadFile.

Enumerator
Okay 
NotFound 
OtherError 

Definition at line 29 of file disk_interface.h.

Constructor & Destructor Documentation

◆ ~FileReader()

virtual FileReader::~FileReader ( )
inlinevirtual

Definition at line 26 of file disk_interface.h.

Member Function Documentation

◆ ReadFile()

virtual Status FileReader::ReadFile ( const std::string &  path,
std::string *  contents,
std::string *  err 
)
pure virtual

Read and store in given string.

On success, return Okay. On error, return another Status and fill |err|.

Implemented in VirtualFileSystem, and RealDiskInterface.

Referenced by Builder::ExtractDeps().


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