Base for mmap_source and mmap_sink with a specific value type. More...

#include <mmap.h>

Public Types
using	value_type
using	size_type
using	reference
using	const_reference
using	pointer
using	const_pointer
using	difference_type
using	iterator
using	const_iterator
using	reverse_iterator
using	const_reverse_iterator
using	iterator_category
using	handle_type

Public Member Functions
	basic_mmap_base (basic_mmap_base &&other) noexcept
handle_type	file_handle () const noexcept
handle_type	mapping_handle () const noexcept
bool	is_open () const noexcept
bool	empty () const noexcept
bool	is_mapped () const noexcept
template<typename T = VALUE_TYPE>
std::span< T const >	to_span () const noexcept
size_type	size () const noexcept
size_type	length () const noexcept
size_type	mapped_length () const noexcept
size_type	mapping_offset () const noexcept
const_pointer	data () const noexcept
const_iterator	begin () const noexcept
const_iterator	cbegin () const noexcept
const_iterator	end () const noexcept
const_iterator	cend () const noexcept
const_reverse_iterator	rbegin () const noexcept
const_reverse_iterator	crbegin () const noexcept
const_reverse_iterator	rend () const noexcept
const_reverse_iterator	crend () const noexcept
const_reference	operator[] (const size_type i) const noexcept
void	swap (basic_mmap_base &other) noexcept
void	unmap () noexcept

Protected Member Functions
const_pointer	get_mapping_start () const noexcept

Protected Attributes
pointer	data_
size_type	length_
size_type	mapped_length_
handle_type	file_handle_
handle_type	file_mapping_handle_

Detailed Description

template<typename VALUE_TYPE>
struct ghassanpl::basic_mmap_base< VALUE_TYPE >

Base for mmap_source and mmap_sink with a specific value type.

Definition at line 90 of file mmap.h.

Member Typedef Documentation

◆ const_iterator

template<typename VALUE_TYPE>

using ghassanpl::basic_mmap_base< VALUE_TYPE >::const_iterator

Definition at line 102 of file mmap.h.

◆ const_pointer

template<typename VALUE_TYPE>

using ghassanpl::basic_mmap_base< VALUE_TYPE >::const_pointer

Definition at line 99 of file mmap.h.

◆ const_reference

template<typename VALUE_TYPE>

using ghassanpl::basic_mmap_base< VALUE_TYPE >::const_reference

Definition at line 97 of file mmap.h.

◆ const_reverse_iterator

template<typename VALUE_TYPE>

using ghassanpl::basic_mmap_base< VALUE_TYPE >::const_reverse_iterator

Definition at line 104 of file mmap.h.

◆ difference_type

template<typename VALUE_TYPE>

using ghassanpl::basic_mmap_base< VALUE_TYPE >::difference_type

Definition at line 100 of file mmap.h.

◆ handle_type

template<typename VALUE_TYPE>

using ghassanpl::basic_mmap_base< VALUE_TYPE >::handle_type

Definition at line 106 of file mmap.h.

◆ iterator

template<typename VALUE_TYPE>

using ghassanpl::basic_mmap_base< VALUE_TYPE >::iterator

Definition at line 101 of file mmap.h.

◆ iterator_category

template<typename VALUE_TYPE>

using ghassanpl::basic_mmap_base< VALUE_TYPE >::iterator_category

Definition at line 105 of file mmap.h.

◆ pointer

template<typename VALUE_TYPE>

using ghassanpl::basic_mmap_base< VALUE_TYPE >::pointer

Definition at line 98 of file mmap.h.

◆ reference

template<typename VALUE_TYPE>

using ghassanpl::basic_mmap_base< VALUE_TYPE >::reference

Definition at line 96 of file mmap.h.

◆ reverse_iterator

template<typename VALUE_TYPE>

using ghassanpl::basic_mmap_base< VALUE_TYPE >::reverse_iterator

Definition at line 103 of file mmap.h.

◆ size_type

template<typename VALUE_TYPE>

using ghassanpl::basic_mmap_base< VALUE_TYPE >::size_type

Definition at line 95 of file mmap.h.

◆ value_type

template<typename VALUE_TYPE>

using ghassanpl::basic_mmap_base< VALUE_TYPE >::value_type

Definition at line 94 of file mmap.h.

Constructor & Destructor Documentation

◆ basic_mmap_base()

template<typename VALUE_TYPE>

ghassanpl::basic_mmap_base< VALUE_TYPE >::basic_mmap_base ( basic_mmap_base< VALUE_TYPE > && other )

inlinenoexcept

Definition at line 109 of file mmap.h.

Member Function Documentation

◆ begin()

template<typename VALUE_TYPE>

const_iterator ghassanpl::basic_mmap_base< VALUE_TYPE >::begin ( ) const

inlinenodiscardnoexcept

Definition at line 148 of file mmap.h.

◆ cbegin()

template<typename VALUE_TYPE>

const_iterator ghassanpl::basic_mmap_base< VALUE_TYPE >::cbegin ( ) const

inlinenodiscardnoexcept

Definition at line 149 of file mmap.h.

◆ cend()

template<typename VALUE_TYPE>

const_iterator ghassanpl::basic_mmap_base< VALUE_TYPE >::cend ( ) const

inlinenodiscardnoexcept

Definition at line 152 of file mmap.h.

◆ crbegin()

template<typename VALUE_TYPE>

const_reverse_iterator ghassanpl::basic_mmap_base< VALUE_TYPE >::crbegin ( ) const

inlinenodiscardnoexcept

Definition at line 159 of file mmap.h.

◆ crend()

template<typename VALUE_TYPE>

const_reverse_iterator ghassanpl::basic_mmap_base< VALUE_TYPE >::crend ( ) const

inlinenodiscardnoexcept

Definition at line 168 of file mmap.h.

◆ data()

template<typename VALUE_TYPE>

const_pointer ghassanpl::basic_mmap_base< VALUE_TYPE >::data ( ) const

inlinenodiscardnoexcept

Definition at line 146 of file mmap.h.

◆ empty()

template<typename VALUE_TYPE>

bool ghassanpl::basic_mmap_base< VALUE_TYPE >::empty ( ) const

inlinenodiscardnoexcept

Definition at line 123 of file mmap.h.

◆ end()

template<typename VALUE_TYPE>

const_iterator ghassanpl::basic_mmap_base< VALUE_TYPE >::end ( ) const

inlinenodiscardnoexcept

Definition at line 151 of file mmap.h.

◆ file_handle()

template<typename VALUE_TYPE>

handle_type ghassanpl::basic_mmap_base< VALUE_TYPE >::file_handle ( ) const

inlinenodiscardnoexcept

Definition at line 118 of file mmap.h.

◆ get_mapping_start()

template<typename VALUE_TYPE>

const_pointer ghassanpl::basic_mmap_base< VALUE_TYPE >::get_mapping_start ( ) const

inlineprotectednoexcept

Definition at line 208 of file mmap.h.

◆ is_mapped()

template<typename VALUE_TYPE>

bool ghassanpl::basic_mmap_base< VALUE_TYPE >::is_mapped ( ) const

inlinenodiscardnoexcept

Definition at line 125 of file mmap.h.

◆ is_open()

template<typename VALUE_TYPE>

bool ghassanpl::basic_mmap_base< VALUE_TYPE >::is_open ( ) const

inlinenodiscardnoexcept

Definition at line 121 of file mmap.h.

◆ length()

template<typename VALUE_TYPE>

size_type ghassanpl::basic_mmap_base< VALUE_TYPE >::length ( ) const

inlinenodiscardnoexcept

Definition at line 138 of file mmap.h.

◆ mapped_length()

template<typename VALUE_TYPE>

size_type ghassanpl::basic_mmap_base< VALUE_TYPE >::mapped_length ( ) const

inlinenodiscardnoexcept

Definition at line 139 of file mmap.h.

◆ mapping_handle()

template<typename VALUE_TYPE>

handle_type ghassanpl::basic_mmap_base< VALUE_TYPE >::mapping_handle ( ) const

inlinenodiscardnoexcept

Definition at line 119 of file mmap.h.

◆ mapping_offset()

template<typename VALUE_TYPE>

size_type ghassanpl::basic_mmap_base< VALUE_TYPE >::mapping_offset ( ) const

inlinenodiscardnoexcept

Definition at line 141 of file mmap.h.

◆ operator[]()

template<typename VALUE_TYPE>

const_reference ghassanpl::basic_mmap_base< VALUE_TYPE >::operator[] ( const size_type i ) const

inlinenodiscardnoexcept

Definition at line 173 of file mmap.h.

◆ rbegin()

template<typename VALUE_TYPE>

const_reverse_iterator ghassanpl::basic_mmap_base< VALUE_TYPE >::rbegin ( ) const

inlinenodiscardnoexcept

Definition at line 154 of file mmap.h.

◆ rend()

template<typename VALUE_TYPE>

const_reverse_iterator ghassanpl::basic_mmap_base< VALUE_TYPE >::rend ( ) const

inlinenodiscardnoexcept

Definition at line 164 of file mmap.h.

◆ size()

template<typename VALUE_TYPE>

size_type ghassanpl::basic_mmap_base< VALUE_TYPE >::size ( ) const

inlinenodiscardnoexcept

Definition at line 137 of file mmap.h.

◆ swap()

template<typename VALUE_TYPE>

void ghassanpl::basic_mmap_base< VALUE_TYPE >::swap ( basic_mmap_base< VALUE_TYPE > & other )

inlinenoexcept

Definition at line 175 of file mmap.h.

◆ to_span()

template<typename VALUE_TYPE>

template<typename T = VALUE_TYPE>

std::span< T const > ghassanpl::basic_mmap_base< VALUE_TYPE >::to_span ( ) const

inlinenodiscardnoexcept

Definition at line 135 of file mmap.h.

◆ unmap()

template<typename VALUE_TYPE>

void ghassanpl::basic_mmap_base< VALUE_TYPE >::unmap ( )

noexcept

Definition at line 225 of file mmap_impl.h.

Member Data Documentation

◆ data_

template<typename VALUE_TYPE>

pointer ghassanpl::basic_mmap_base< VALUE_TYPE >::data_

protected

Definition at line 200 of file mmap.h.

◆ file_handle_

template<typename VALUE_TYPE>

handle_type ghassanpl::basic_mmap_base< VALUE_TYPE >::file_handle_

protected

Definition at line 205 of file mmap.h.

◆ file_mapping_handle_

template<typename VALUE_TYPE>

handle_type ghassanpl::basic_mmap_base< VALUE_TYPE >::file_mapping_handle_

protected

Definition at line 206 of file mmap.h.

◆ length_

template<typename VALUE_TYPE>

size_type ghassanpl::basic_mmap_base< VALUE_TYPE >::length_

protected

Definition at line 202 of file mmap.h.

◆ mapped_length_

template<typename VALUE_TYPE>

size_type ghassanpl::basic_mmap_base< VALUE_TYPE >::mapped_length_

protected

Definition at line 203 of file mmap.h.

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ const_iterator

◆ const_pointer

◆ const_reference

◆ const_reverse_iterator

◆ difference_type

◆ handle_type

◆ iterator

◆ iterator_category

◆ pointer

◆ reference

◆ reverse_iterator

◆ size_type

◆ value_type

Constructor & Destructor Documentation

◆ basic_mmap_base()

Member Function Documentation

◆ begin()

◆ cbegin()

◆ cend()

◆ crbegin()

◆ crend()

◆ data()

◆ empty()

◆ end()

◆ file_handle()

◆ get_mapping_start()

◆ is_mapped()

◆ is_open()

◆ length()

◆ mapped_length()

◆ mapping_handle()

◆ mapping_offset()

◆ operator[]()

◆ rbegin()

◆ rend()

◆ size()

◆ swap()

◆ to_span()

◆ unmap()

Member Data Documentation

◆ data_

◆ file_handle_

◆ file_mapping_handle_

◆ length_

◆ mapped_length_