afio_v2_xxx::algorithm::mapped_span< T > Class Template Reference

Provides a typed mapped view of a section_handle suitable for feeding to STL algorithms or the Ranges TS by wrapping a map_handle into a span<T>. More...

#include "mapped_span.hpp"

Inheritance diagram for afio_v2_xxx::algorithm::mapped_span< T >:

Public Types
using	extent_type = typename section_handle::extent_type
	The extent type.
using	size_type = typename section_handle::size_type
	The size type.

Public Member Functions
constexpr	mapped_span ()
	Default constructor.
	mapped_span (size_type length, section_handle::flag _flag=section_handle::flag::readwrite)
	mapped_span (section_handle &sh, size_type length=(size_type) -1, extent_type byteoffset=0, section_handle::flag _flag=section_handle::flag::readwrite)
	mapped_span (map_handle &mh, size_type length=(size_type) -1, extent_type byteoffset=0)
	mapped_span (mapped_file_handle &mfh, size_type length=(size_type) -1, extent_type byteoffset=0)

Detailed Description

template<class T>
class afio_v2_xxx::algorithm::mapped_span< T >

Provides a typed mapped view of a section_handle suitable for feeding to STL algorithms or the Ranges TS by wrapping a map_handle into a span<T>.

Optionally can issue a blocking write barrier on destruction of the mapped view by setting the flag section_handle::flag::barrier_on_close, thus forcing any changes to data referred to by the view to storage before the destructor returns.

Constructor & Destructor Documentation

mapped_span() [1/4]

template<class T >

afio_v2_xxx::algorithm::mapped_span< T >::mapped_span ( size_type  length, section_handle::flag  _flag = section_handle::flag::readwrite  )

inlineexplicit

Create a view of new memory.

Parameters

length	The number of items to map.
_flag	The flags to pass to map_handle::map().

        : _mapping(map_handle::map(length * sizeof(T), _flag).value())
    {
      byte *addr = _mapping.address();
      static_cast<span<T> &>(*this) = span<T>(reinterpret_cast<T *>(addr), length);  // NOLINT
    }

mapped_span() [2/4]

template<class T >

afio_v2_xxx::algorithm::mapped_span< T >::mapped_span ( section_handle &  sh, size_type  length = (size_type) -1, extent_type  byteoffset = 0, section_handle::flag  _flag = section_handle::flag::readwrite  )

inlineexplicit

Construct a mapped view of the given section handle.

Parameters

sh	The section handle to use as the data source for creating the map.
length	The number of items to map, use -1 to mean the length of the section handle divided by sizeof(T).
byteoffset	The byte offset into the section handle, this does not need to be a multiple of the page size.
_flag	The flags to pass to map_handle::map().

    : mapped_span((length == 0) ? mapped_span() : mapped_span(
#ifdef _WIN32
                                                  byteoffset & ~65535,
#else
                                                  utils::round_down_to_page_size(byteoffset),
#endif
                                                  byteoffset, sh, (length == (size_type) -1) ? 0 : length * sizeof(T), _flag))  // NOLINT
    {
    }

mapped_span() [3/4]

template<class T >

afio_v2_xxx::algorithm::mapped_span< T >::mapped_span ( map_handle &  mh, size_type  length = (size_type) -1, extent_type  byteoffset = 0  )

inlineexplicit

Construct a mapped view of the given map handle.

Parameters

mh	The map handle to use.
length	The number of items to map, use -1 to mean the length of the map handle divided by sizeof(T).
byteoffset	The byte offset into the map handle, this does not need to be a multiple of the page size.

    : span<T>(reinterpret_cast<T *>(mh.address() + byteoffset), (length == (size_type) -1) ? ((mh.length() - byteoffset) / sizeof(T)) : length)  // NOLINT
    {
    }

mapped_span() [4/4]

template<class T >

afio_v2_xxx::algorithm::mapped_span< T >::mapped_span ( mapped_file_handle &  mfh, size_type  length = (size_type) -1, extent_type  byteoffset = 0  )

inlineexplicit

Construct a mapped view of the given mapped file handle.

Parameters

mfh	The mapped file handle to use as the data source for creating the map.
length	The number of items to map, use -1 to mean the length of the section handle divided by sizeof(T).
byteoffset	The byte offset into the mapped file handle, this does not need to be a multiple of the page size.

    : span<T>(reinterpret_cast<T *>(mfh.address() + byteoffset), (length == (size_type) -1) ? ((mfh.maximum_extent().value() - byteoffset) / sizeof(T)) : length)  // NOLINT
    {
    }

---

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

• include/afio/v2.0/algorithm/mapped_span.hpp