io.h File Reference

Copyright 2014-2023, XGBoost Contributors. More...

#include <dmlc/io.h>
#include <rabit/rabit.h>
#include <algorithm>
#include <array>
#include <cstddef>
#include <cstdlib>
#include <cstring>
#include <fstream>
#include <limits>
#include <memory>
#include <string>
#include <type_traits>
#include <utility>
#include <vector>
#include "common.h"
#include "xgboost/string_view.h"

Go to the source code of this file.

Data Structures
class	xgboost::common::PeekableInStream
	Input stream that support additional PeekRead operation, besides read. More...
class	xgboost::common::FixedSizeStream
	A simple class used to consume ‘dmlc::Stream’ all at once. More...
class	xgboost::common::ResourceHandler
	Handler for one-shot resource. More...
class	xgboost::common::MallocResource
class	xgboost::common::MmapResource
	A class for wrapping mmap as a resource for RAII. More...
class	xgboost::common::AlignedResourceReadStream
	Wrap resource into a dmlc stream. More...
class	xgboost::common::PrivateMmapConstStream
	Private mmap file as a read-only stream. More...
class	xgboost::common::AlignedWriteStream
	Base class for write stream with alignment defined by IOAlignment(). More...
class	xgboost::common::AlignedFileWriteStream
	Output stream backed by a file. More...
class	xgboost::common::AlignedMemWriteStream
	Output stream backed by memory buffer. More...

Namespaces
namespace	xgboost
	namespace of xgboost
namespace	xgboost::common
	Copyright 2017-2023, XGBoost Contributors.

Typedefs
using	xgboost::common::MemoryFixSizeBuffer = rabit::utils::MemoryFixSizeBuffer
using	xgboost::common::MemoryBufferStream = rabit::utils::MemoryBufferStream

Functions
std::string	xgboost::common::LoadSequentialFile (std::string uri, bool stream=false)
	Helper function for loading consecutive file to avoid dmlc Stream when possible.
std::string	xgboost::common::FileExtension (std::string fname, bool lower=true)
	Get file extension from file name.
std::string	xgboost::common::ReadAll (dmlc::Stream *fi, PeekableInStream *fp)
	Read the whole buffer from dmlc stream.
std::string	xgboost::common::ReadAll (std::string const &path)
	Read the whole file content into a string.
constexpr std::size_t	xgboost::common::IOAlignment ()

Detailed Description

Copyright 2014-2023, XGBoost Contributors.

general stream interface for serialization, I/O

Author

Tianqi Chen