LLVM  4.0.0
Public Types | Public Member Functions | Static Public Member Functions | List of all members
llvm::sys::fs::mapped_file_region Class Reference

This class represents a memory mapped file. More...

#include <FileSystem.h>

Public Types

enum  mapmode { readonly, readwrite, priv }
 

Public Member Functions

 mapped_file_region ()=delete
 
 mapped_file_region (mapped_file_region &)=delete
 
mapped_file_regionoperator= (mapped_file_region &)=delete
 
 mapped_file_region (int fd, mapmode mode, uint64_t length, uint64_t offset, std::error_code &ec)
 
 ~mapped_file_region ()
 
uint64_t size () const
 
char * data () const
 
const char * const_data () const
 Get a const view of the data. More...
 

Static Public Member Functions

static int alignment ()
 

Detailed Description

This class represents a memory mapped file.

It is based on boost::iostreams::mapped_file.

Definition at line 685 of file FileSystem.h.

Member Enumeration Documentation

Enumerator
readonly 

May only access map via const_data as read only.

readwrite 

May access map via data and modify it. Written to path.

priv 

May modify via data, but changes are lost on destruction.

Definition at line 687 of file FileSystem.h.

Constructor & Destructor Documentation

llvm::sys::fs::mapped_file_region::mapped_file_region ( )
delete
llvm::sys::fs::mapped_file_region::mapped_file_region ( mapped_file_region )
delete
llvm::sys::fs::mapped_file_region::mapped_file_region ( int  fd,
mapmode  mode,
uint64_t  length,
uint64_t  offset,
std::error_code &  ec 
)
Parameters
fdAn open file descriptor to map. mapped_file_region takes ownership if closefd is true. It must have been opended in the correct mode.
llvm::sys::fs::mapped_file_region::~mapped_file_region ( )

Member Function Documentation

static int llvm::sys::fs::mapped_file_region::alignment ( )
static
Returns
The minimum alignment offset must be.
const char* llvm::sys::fs::mapped_file_region::const_data ( ) const

Get a const view of the data.

Modifying this memory has undefined behavior.

char* llvm::sys::fs::mapped_file_region::data ( ) const
mapped_file_region& llvm::sys::fs::mapped_file_region::operator= ( mapped_file_region )
delete
uint64_t llvm::sys::fs::mapped_file_region::size ( ) const

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