mmap

Classes
struct	ghassanpl::mmap_source< VALUE_TYPE >
	A read-only memory view over a file. More...
struct	ghassanpl::mmap_sink< VALUE_TYPE >
	A read-write view over a file. More...

Typedefs
using	ghassanpl::byte_mmap_source = mmap_source< std::byte >
using	ghassanpl::u8_mmap_source = mmap_source< std::uint8_t >
using	ghassanpl::char_mmap_source = mmap_source< char >
using	ghassanpl::char8_mmap_source = mmap_source< char8_t >

Functions
template<typename VALUE_TYPE >
mmap_source< VALUE_TYPE >	ghassanpl::make_mmap_source (const std::filesystem::path &path, typename mmap_source< VALUE_TYPE >::size_type offset, typename mmap_source< VALUE_TYPE >::size_type length, std::error_code &error) noexcept
template<typename VALUE_TYPE >
mmap_source< VALUE_TYPE >	ghassanpl::make_mmap_source (const std::filesystem::path &path, std::error_code &error) noexcept
template<typename VALUE_TYPE >
mmap_source< VALUE_TYPE >	ghassanpl::make_mmap_source (const std::filesystem::path &path, typename mmap_source< VALUE_TYPE >::size_type offset, typename mmap_source< VALUE_TYPE >::size_type length)
template<typename VALUE_TYPE >
mmap_source< VALUE_TYPE >	ghassanpl::make_mmap_source (const std::filesystem::path &path)
template<typename VALUE_TYPE >
mmap_sink< VALUE_TYPE >	ghassanpl::make_mmap_sink (const std::filesystem::path &path, typename mmap_sink< VALUE_TYPE >::size_type offset, typename mmap_sink< VALUE_TYPE >::size_type length, std::error_code &error) noexcept
template<typename VALUE_TYPE >
mmap_sink< VALUE_TYPE >	ghassanpl::make_mmap_sink (const std::filesystem::path &path, std::error_code &error) noexcept
template<typename VALUE_TYPE >
mmap_sink< VALUE_TYPE >	ghassanpl::make_mmap_sink (const std::filesystem::path &path, typename mmap_sink< VALUE_TYPE >::size_type offset, typename mmap_sink< VALUE_TYPE >::size_type length)
template<typename VALUE_TYPE >
mmap_sink< VALUE_TYPE >	ghassanpl::make_mmap_sink (const std::filesystem::path &path)

Detailed Description

Typedef Documentation

byte_mmap_source

using ghassanpl::byte_mmap_source = typedef mmap_source<std::byte>

Definition at line 342 of file mmap.h.

char8_mmap_source

using ghassanpl::char8_mmap_source = typedef mmap_source<char8_t>

Definition at line 345 of file mmap.h.

char_mmap_source

using ghassanpl::char_mmap_source = typedef mmap_source<char>

Definition at line 344 of file mmap.h.

u8_mmap_source

using ghassanpl::u8_mmap_source = typedef mmap_source<std::uint8_t>

Definition at line 343 of file mmap.h.

Function Documentation

make_mmap_sink() [1/4]

template<typename VALUE_TYPE >

mmap_sink< VALUE_TYPE > ghassanpl::make_mmap_sink ( const std::filesystem::path &  path )

inline

Definition at line 448 of file mmap.h.

make_mmap_sink() [2/4]

template<typename VALUE_TYPE >

mmap_sink< VALUE_TYPE > ghassanpl::make_mmap_sink ( const std::filesystem::path &  path, std::error_code &  error  )

inlinenoexcept

Definition at line 436 of file mmap.h.

make_mmap_sink() [3/4]

template<typename VALUE_TYPE >

mmap_sink< VALUE_TYPE > ghassanpl::make_mmap_sink ( const std::filesystem::path &  path, typename mmap_sink< VALUE_TYPE >::size_type  offset, typename mmap_sink< VALUE_TYPE >::size_type  length  )

inline

Definition at line 442 of file mmap.h.

make_mmap_sink() [4/4]

template<typename VALUE_TYPE >

mmap_sink< VALUE_TYPE > ghassanpl::make_mmap_sink ( const std::filesystem::path &  path, typename mmap_sink< VALUE_TYPE >::size_type  offset, typename mmap_sink< VALUE_TYPE >::size_type  length, std::error_code &  error  )

inlinenoexcept

Definition at line 428 of file mmap.h.

make_mmap_source() [1/4]

template<typename VALUE_TYPE >

mmap_source< VALUE_TYPE > ghassanpl::make_mmap_source ( const std::filesystem::path &  path )

inline

Definition at line 422 of file mmap.h.

make_mmap_source() [2/4]

template<typename VALUE_TYPE >

mmap_source< VALUE_TYPE > ghassanpl::make_mmap_source ( const std::filesystem::path &  path, std::error_code &  error  )

inlinenoexcept

Definition at line 410 of file mmap.h.

make_mmap_source() [3/4]

template<typename VALUE_TYPE >

mmap_source< VALUE_TYPE > ghassanpl::make_mmap_source ( const std::filesystem::path &  path, typename mmap_source< VALUE_TYPE >::size_type  offset, typename mmap_source< VALUE_TYPE >::size_type  length  )

inline

Definition at line 416 of file mmap.h.

make_mmap_source() [4/4]

template<typename VALUE_TYPE >

mmap_source< VALUE_TYPE > ghassanpl::make_mmap_source ( const std::filesystem::path &  path, typename mmap_source< VALUE_TYPE >::size_type  offset, typename mmap_source< VALUE_TYPE >::size_type  length, std::error_code &  error  )

inlinenoexcept

Definition at line 402 of file mmap.h.