class mapped_file_region

Declaration

class mapped_file_region { /* full declaration omitted */ };

Description

This class represents a memory mapped file. It is based on boost::iostreams::mapped_file.

Declared at: llvm/include/llvm/Support/FileSystem.h:1160

Method Overview

• public static int alignment()
• public const char * const_data() const
• public char * data() const
• public mapped_file_region()
• public mapped_file_region(llvm::sys::fs::mapped_file_region &)
• public mapped_file_region(sys::fs::file_t fd, llvm::sys::fs::mapped_file_region::mapmode mode, size_t length, uint64_t offset, std::error_code & ec)
• public size_t size() const
• public ~mapped_file_region()

Methods

¶static int alignment()

Declared at: llvm/include/llvm/Support/FileSystem.h:1198

Returns

The minimum alignment offset must be.

¶const char* const_data() const

Description

Get a const view of the data. Modifying this memory has undefined behavior.

Declared at: llvm/include/llvm/Support/FileSystem.h:1195

¶char* data() const

Declared at: llvm/include/llvm/Support/FileSystem.h:1191

¶mapped_file_region()

Declared at: llvm/include/llvm/Support/FileSystem.h:1180

¶mapped_file_region(
    llvm::sys::fs::mapped_file_region&)

Declared at: llvm/include/llvm/Support/FileSystem.h:1181

Parameters

llvm::sys::fs::mapped_file_region&

¶mapped_file_region(
    sys::fs::file_t fd,
    llvm::sys::fs::mapped_file_region::mapmode
        mode,
    size_t length,
    uint64_t offset,
    std::error_code& ec)

Declared at: llvm/include/llvm/Support/FileSystem.h:1185

Parameters

sys::fs::file_t fd

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

llvm::sys::fs::mapped_file_region::mapmode mode

size_t length

uint64_t offset

std::error_code& ec

¶size_t size() const

Declared at: llvm/include/llvm/Support/FileSystem.h:1190

¶~mapped_file_region()

Declared at: llvm/include/llvm/Support/FileSystem.h:1188