imr::util::MemoryMappedFile::Config Struct Reference

#include <memory_mapped_file.h>

Public Attributes
std::filesystem::path	path
	Path of the file to map.
int	mmap_flags {0}
	Additional mmap() flags, OR'd with MAP_PRIVATE.
int	madvise_flags {0}
	Flags passed to madvise() after mapping. Pass 0 to skip madvise() call entirely.

Member Data Documentation

path

std::filesystem::path imr::util::MemoryMappedFile::Config::path

Path of the file to map.

Exceptions

std::invalid_argument	if invalid path or directory
std::system_error	if open() fails

mmap_flags

int imr::util::MemoryMappedFile::Config::mmap_flags {0}

Additional mmap() flags, OR'd with MAP_PRIVATE.

MAP_PRIVATE is always used since the mapping is read only, but you can pass additional flags via this.

madvise_flags

int imr::util::MemoryMappedFile::Config::madvise_flags {0}

Flags passed to madvise() after mapping. Pass 0 to skip madvise() call entirely.

---

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

• include/imr/util/memory_mapped_file.h