LightGBM::VirtualFileReader Struct Reference

An interface for reading files into buffers. More...

#include <file_io.h>

Inheritance diagram for LightGBM::VirtualFileReader:

Public Member Functions
virtual	~VirtualFileReader ()
	Constructor.
virtual bool	Init ()=0
	Initialize the reader.
virtual size_t	Read (void *buffer, size_t bytes) const =0
	Read data into buffer.

Static Public Member Functions
static std::unique_ptr< VirtualFileReader >	Make (const std::string &filename)
	Create appropriate reader for filename.

Detailed Description

An interface for reading files into buffers.

Constructor & Destructor Documentation

~VirtualFileReader()

virtual LightGBM::VirtualFileReader::~VirtualFileReader ( )

inlinevirtual

Constructor.

Parameters

filename

Filename of the data

Member Function Documentation

Init()

virtual bool LightGBM::VirtualFileReader::Init ( )

pure virtual

Initialize the reader.

Returns

True when the file is available for read

Implemented in LightGBM::LocalFile.

Make()

std::unique_ptr< VirtualFileReader > LightGBM::VirtualFileReader::Make ( const std::string &  filename )

static

Create appropriate reader for filename.

Parameters

filename

Filename of the data

Returns

File reader instance

Read()

virtual size_t LightGBM::VirtualFileReader::Read ( void *  buffer, size_t  bytes  ) const

pure virtual

Read data into buffer.

Parameters

buffer	Buffer to read data into
bytes	Number of bytes to read

Returns

Number of bytes read

Implemented in LightGBM::LocalFile.

---

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

• External/LightGBM_2.2.3/LightGBM-2.2.3/include/LightGBM/utils/file_io.h
• External/LightGBM_2.2.3/LightGBM-2.2.3/src/io/file_io.cpp