header_utils
Loading...
Searching...
No Matches
ghassanpl::mmap_sink< VALUE_TYPE > Struct Template Reference
Memory Mapped Files

A read-write view over a file. More...

#include <mmap.h>

Public Member Functions

reference operator[] (const size_type i) const noexcept
pointer data () noexcept
iterator begin () noexcept
iterator end () noexcept
reverse_iterator rbegin () noexcept
reverse_iterator rend () noexcept
void sync (std::error_code &error) noexcept

Protected Member Functions

pointer get_mapping_start () noexcept
void conditional_sync ()

Static Protected Member Functions

static file_handle_type open_file (const std::filesystem::path &path, std::error_code &error) noexcept
static mmap_context memory_map (const file_handle_type file_handle, const int64_t offset, const int64_t length, std::error_code &error) noexcept

Friends

struct basic_mmap< mmap_sink< VALUE_TYPE >, VALUE_TYPE >

Detailed Description

template<typename VALUE_TYPE = std::byte>
struct ghassanpl::mmap_sink< VALUE_TYPE >

A read-write view over a file.

Definition at line 360 of file mmap.h.

Member Function Documentation

◆ begin()

template<typename VALUE_TYPE = std::byte>
iterator ghassanpl::mmap_sink< VALUE_TYPE >::begin ( )
inlinenodiscardnoexcept

Definition at line 379 of file mmap.h.

◆ conditional_sync()

template<typename VALUE_TYPE = std::byte>
void ghassanpl::mmap_sink< VALUE_TYPE >::conditional_sync ( )
inlineprotected

Definition at line 405 of file mmap.h.

◆ data()

template<typename VALUE_TYPE = std::byte>
pointer ghassanpl::mmap_sink< VALUE_TYPE >::data ( )
inlinenodiscardnoexcept

Definition at line 376 of file mmap.h.

◆ end()

template<typename VALUE_TYPE = std::byte>
iterator ghassanpl::mmap_sink< VALUE_TYPE >::end ( )
inlinenodiscardnoexcept

Definition at line 382 of file mmap.h.

◆ get_mapping_start()

template<typename VALUE_TYPE = std::byte>
pointer ghassanpl::mmap_sink< VALUE_TYPE >::get_mapping_start ( )
inlineprotectednoexcept

Definition at line 400 of file mmap.h.

◆ memory_map()

template<typename VALUE_TYPE>
mmap_sink< VALUE_TYPE >::mmap_context ghassanpl::mmap_sink< VALUE_TYPE >::memory_map ( const file_handle_type file_handle,
const int64_t offset,
const int64_t length,
std::error_code & error )
staticprotectednoexcept

Definition at line 188 of file mmap_impl.h.

◆ open_file()

template<typename VALUE_TYPE>
file_handle_type ghassanpl::mmap_sink< VALUE_TYPE >::open_file ( const std::filesystem::path & path,
std::error_code & error )
staticprotectednoexcept

Definition at line 168 of file mmap_impl.h.

◆ operator[]()

template<typename VALUE_TYPE = std::byte>
reference ghassanpl::mmap_sink< VALUE_TYPE >::operator[] ( const size_type i) const
inlinenodiscardnoexcept

Definition at line 371 of file mmap.h.

◆ rbegin()

template<typename VALUE_TYPE = std::byte>
reverse_iterator ghassanpl::mmap_sink< VALUE_TYPE >::rbegin ( )
inlinenodiscardnoexcept

Definition at line 385 of file mmap.h.

◆ rend()

template<typename VALUE_TYPE = std::byte>
reverse_iterator ghassanpl::mmap_sink< VALUE_TYPE >::rend ( )
inlinenodiscardnoexcept

Definition at line 388 of file mmap.h.

◆ sync()

template<typename VALUE_TYPE>
void ghassanpl::mmap_sink< VALUE_TYPE >::sync ( std::error_code & error)
noexcept

Definition at line 137 of file mmap_impl.h.

◆ basic_mmap< mmap_sink< VALUE_TYPE >, VALUE_TYPE >

template<typename VALUE_TYPE = std::byte>
friend struct basic_mmap< mmap_sink< VALUE_TYPE >, VALUE_TYPE >
friend

Definition at line 390 of file mmap.h.