LLVM: llvm::sys::fs::mapped_file_region Class Reference (original) (raw)

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

#include "[llvm/Support/FileSystem.h](FileSystem%5F8h%5Fsource.html)"

Public Types
enum mapmode { readonly, readwrite, priv }
Public Member Functions
mapped_file_region ()=default
mapped_file_region (mapped_file_region &&Moved)
mapped_file_region & operator= (mapped_file_region &&Moved)
mapped_file_region (const mapped_file_region &)=delete
mapped_file_region & operator= (const mapped_file_region &)=delete
LLVM_ABI mapped_file_region (sys::fs::file_t fd, mapmode mode, size_t length, uint64_t offset, std::error_code &ec)
~mapped_file_region ()
operator bool () const
Check if this is a valid mapping.
void unmap ()
Unmap.
void dontNeed ()
LLVM_ABI size_t size () const
LLVM_ABI char * data () const
LLVM_ABI std::error_code sync () const
Write changes to disk and synchronize.
LLVM_ABI const char * const_data () const
Get a const view of the data.
Static Public Member Functions
static LLVM_ABI int alignment ()

This class represents a memory mapped file.

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

Definition at line 1280 of file FileSystem.h.

◆ mapmode

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 1282 of file FileSystem.h.

llvm::sys::fs::mapped_file_region::mapped_file_region ( ) default

◆ mapped_file_region() [2/4]

llvm::sys::fs::mapped_file_region::mapped_file_region ( mapped_file_region && Moved) inline

◆ mapped_file_region() [3/4]

References mapped_file_region().

◆ mapped_file_region() [4/4]

Parameters

fd An open file descriptor to map. Does not take ownership of fd.

References LLVM_ABI, and mode.

◆ ~mapped_file_region()

llvm::sys::fs::mapped_file_region::~mapped_file_region ( ) inline

◆ alignment()

LLVM_ABI int llvm::sys::fs::mapped_file_region::alignment ( ) static

Returns

The minimum alignment offset must be.

References LLVM_ABI.

◆ const_data()

const char * llvm::sys::fs::mapped_file_region::const_data ( ) const

◆ data()

char * llvm::sys::fs::mapped_file_region::data ( ) const

◆ dontNeed()

void llvm::sys::fs::mapped_file_region::dontNeed ( ) inline

◆ operator bool()

llvm::sys::fs::mapped_file_region::operator bool ( ) const inlineexplicit

◆ operator=() [1/2]

References mapped_file_region().

◆ operator=() [2/2]

◆ size()

size_t llvm::sys::fs::mapped_file_region::size ( ) const

◆ sync()

LLVM_ABI std::error_code llvm::sys::fs::mapped_file_region::sync ( ) const

Write changes to disk and synchronize.

Equivalent to POSIX msync. This will wait for flushing memory-mapped region back to disk and can be very slow.

References LLVM_ABI.

◆ unmap()

void llvm::sys::fs::mapped_file_region::unmap ( ) inline

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