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

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

#include <base64.h>

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

Public Member Functions

 Base64OutStream (dmlc::Stream *fp)
 
virtual void Write (const void *ptr, size_t size)
 writes data to a stream
 
virtual size_t Read (void *ptr, size_t size)
 reads data from a stream
 
void Finish (char endch=EOF)
 finish writing of all current base64 stream, do some post processing
 
- 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 write to base64, note we take from file pointers

Member Function Documentation

◆ Finish()

void xgboost::common::Base64OutStream::Finish ( char  endch = EOF)
inline

finish writing of all current base64 stream, do some post processing

Parameters
endchcharacter to put to end of stream, if it is EOF, then nothing will be done

◆ Read()

virtual size_t xgboost::common::Base64OutStream::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::Base64OutStream::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: