xgboost::common::MmapResource Class Reference

A class for wrapping mmap as a resource for RAII. More...

#include <io.h>

Inheritance diagram for xgboost::common::MmapResource:

Public Member Functions
	MmapResource (std::string path, std::size_t offset, std::size_t length)
void *	Data () override
std::size_t	Size () const override
Public Member Functions inherited from xgboost::common::ResourceHandler
template<typename T >
T *	DataAs ()
auto	Type () const
	ResourceHandler (Kind kind)
	ResourceHandler (ResourceHandler const &that)=delete
ResourceHandler &	operator= (ResourceHandler const &that)=delete
	ResourceHandler (ResourceHandler &&that)=delete
ResourceHandler &	operator= (ResourceHandler &&that)=delete
bool	IsSameType (ResourceHandler const &that) const
	Wether two resources have the same type.

Additional Inherited Members
Public Types inherited from xgboost::common::ResourceHandler
enum	Kind : std::uint8_t { kMalloc = 0 , kMmap = 1 }

Detailed Description

A class for wrapping mmap as a resource for RAII.

Member Function Documentation

Data()

void * xgboost::common::MmapResource::Data ( )

overridevirtual

Implements xgboost::common::ResourceHandler.

Size()

std::size_t xgboost::common::MmapResource::Size ( ) const

overridevirtual

Implements xgboost::common::ResourceHandler.

---

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

• External/xgboost/src/common/io.h
• External/xgboost/src/common/io.cc