dmlc::io::s3::WriteStream Class Reference

Inheritance diagram for dmlc::io::s3::WriteStream:

Public Member Functions
	WriteStream (const URI &path, const std::string &s3_id, const std::string &s3_key, const std::string &s3_session_token, const std::string &s3_region, const std::string &s3_endpoint, bool s3_verify_ssl, bool s3_is_aws)
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
virtual void	Close ()
	Closes the write 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 Stream *	Create (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

Member Function Documentation

Read()

virtual size_t dmlc::io::s3::WriteStream::Read ( void *  ptr, size_t  size  )

inlinevirtual

reads data from a stream

Parameters

ptr	pointer to a memory buffer
size	block size

Returns

the size of data read

Implements dmlc::Stream.

Write()

void dmlc::io::s3::WriteStream::Write ( const void *  ptr, size_t  size  )

virtual

writes data to a stream

Parameters

ptr	pointer to a memory buffer
size	block size

Implements dmlc::Stream.

---

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

• External/xgboost/dmlc-core/src/io/s3_filesys.cc