Medial Code Documentation
Loading...
Searching...
No Matches
Public Member Functions
xgboost::common::Base64InStream Class Reference

the stream that reads from base64, note we take from file pointers More...

#include <base64.h>

Inheritance diagram for xgboost::common::Base64InStream:
dmlc::Stream

Public Member Functions

 Base64InStream (dmlc::Stream *fs)
 
void InitPosition (void)
 initialize the stream position to beginning of next base64 stream call this function before actually start read
 
bool IsEOF (void) const
 whether current position is end of a base64 stream
 
virtual size_t Read (void *ptr, size_t size)
 reads data from a stream
 
virtual void Write (const void *ptr, size_t size)
 writes data to a stream
 
- Public Member Functions inherited from dmlc::Stream
virtual ~Stream (void)
 virtual destructor
 
template<typename T >
void Write (const T &data)
 writes a data to stream.
 
template<typename T >
bool Read (T *out_data)
 loads a data from stream.
 
template<typename T >
void WriteArray (const T *data, size_t num_elems)
 Endian aware write array of data.
 
template<typename T >
bool ReadArray (T *data, size_t num_elems)
 Endian aware read array of data.
 

Additional Inherited Members

- Static Public Member Functions inherited from dmlc::Stream
static StreamCreate (const char *uri, const char *const flag, bool allow_null=false)
 generic factory function create an stream, the stream will close the underlying files upon deletion
 

Detailed Description

the stream that reads from base64, note we take from file pointers

Member Function Documentation

◆ Read()

virtual size_t xgboost::common::Base64InStream::Read ( void *  ptr,
size_t  size 
)
inlinevirtual

reads data from a stream

Parameters
ptrpointer to a memory buffer
sizeblock size
Returns
the size of data read

Implements dmlc::Stream.

◆ Write()

virtual void xgboost::common::Base64InStream::Write ( const void *  ptr,
size_t  size 
)
inlinevirtual

writes data to a stream

Parameters
ptrpointer to a memory buffer
sizeblock size

Implements dmlc::Stream.


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