MemMap.hpp

Go to the documentation of this file.

#pragma once
 
#include <cstdint>
 
#include "vc/core/filesystem.hpp"
 
namespace volcart
{
 
namespace endian
{
auto little() -> bool;
 
auto big() -> bool;
}  // namespace endian
 
struct mmap_info {
    explicit operator bool() const;
    void* addr{nullptr};
    std::int64_t size{-1};
};
 
struct auto_mmap_info : mmap_info {
    auto_mmap_info() = default;
 
    explicit auto_mmap_info(const mmap_info& rhs);
    explicit auto_mmap_info(mmap_info&& rhs);
    auto operator=(const mmap_info& rhs) -> auto_mmap_info&;
    auto operator=(mmap_info&& rhs) -> auto_mmap_info&;
 
    auto operator=(auto_mmap_info&& rhs) noexcept -> auto_mmap_info&;
 
    explicit auto_mmap_info(auto_mmap_info&) = delete;
    explicit auto_mmap_info(const auto_mmap_info&) = delete;
    auto operator=(auto_mmap_info&) -> auto_mmap_info& = delete;
    auto operator=(const auto_mmap_info&) -> auto_mmap_info& = delete;
 
    ~auto_mmap_info();
};
 
auto MemmapFile(const filesystem::path& path) -> mmap_info;
 
auto UnmapFile(mmap_info& mmap_info) -> int;
 
auto memmap_supported() -> bool;
}  // namespace volcart