Medial Code Documentation
Loading...
Searching...
No Matches
Public Member Functions
LightGBM::LocalFile Struct Reference
Inheritance diagram for LightGBM::LocalFile:
LightGBM::VirtualFileReader LightGBM::VirtualFileWriter

Public Member Functions

 LocalFile (const std::string &filename, const std::string &mode)
 
bool Init ()
 Initialize the reader.
 
bool Exists () const
 
size_t Read (void *buffer, size_t bytes) const
 Read data into buffer.
 
size_t Write (const void *buffer, size_t bytes) const
 Append buffer to file.
 
- Public Member Functions inherited from LightGBM::VirtualFileReader
virtual ~VirtualFileReader ()
 Constructor.
 

Additional Inherited Members

- Static Public Member Functions inherited from LightGBM::VirtualFileReader
static std::unique_ptr< VirtualFileReaderMake (const std::string &filename)
 Create appropriate reader for filename.
 
- Static Public Member Functions inherited from LightGBM::VirtualFileWriter
static std::unique_ptr< VirtualFileWriterMake (const std::string &filename)
 Create appropriate writer for filename.
 
static bool Exists (const std::string &filename)
 Check filename existence.
 

Member Function Documentation

◆ Init()

bool LightGBM::LocalFile::Init ( )
inlinevirtual

Initialize the reader.

Returns
True when the file is available for read

Implements LightGBM::VirtualFileReader.

◆ Read()

size_t LightGBM::LocalFile::Read ( void *  buffer,
size_t  bytes 
) const
inlinevirtual

Read data into buffer.

Parameters
bufferBuffer to read data into
bytesNumber of bytes to read
Returns
Number of bytes read

Implements LightGBM::VirtualFileReader.

◆ Write()

size_t LightGBM::LocalFile::Write ( const void *  data,
size_t  bytes 
) const
inlinevirtual

Append buffer to file.

Parameters
dataBuffer to write from
bytesNumber of bytes to write from buffer
Returns
Number of bytes written

Implements LightGBM::VirtualFileWriter.


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