Everett
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
everett::mapped_profile< P, Role > Struct Template Reference

#include <sections.h>

Public Types

using policy_type = P
 

Public Member Functions

bool active () const noexcept
 
profile_view< P, Role > view () const &
 
profile_view< P, Role > view () const &&=delete
 
std::uint64_t size () const
 
section_detail::directory const & layout () const &
 
section_detail::directory const & layout () const &&=delete
 
std::span< std::byte const > section (std::size_t slot) const &
 
std::span< std::byte const > section (std::size_t) const &&=delete
 
void scan () const
 

Static Public Member Functions

static mapped_profile open (file< P > source)
 
static mapped_profile open (std::filesystem::path const &path)
 
static mapped_profile from_slice (mapped_slice source, file_open_mode mode=file_open_mode::checked)
 

Private Member Functions

void require_active () const
 
 mapped_profile (file< P > source, mapped_slice body, section_detail::directory layout, profile_view< P, Role > view)
 

Private Attributes

file< P > source_
 
mapped_slice body_
 
section_detail::directory layout_
 
profile_view< P, Role > view_
 

Member Typedef Documentation

◆ policy_type

template<class P , stream_role Role>
using everett::mapped_profile< P, Role >::policy_type = P

Constructor & Destructor Documentation

◆ mapped_profile()

template<class P , stream_role Role>
everett::mapped_profile< P, Role >::mapped_profile ( file< P >  source,
mapped_slice  body,
section_detail::directory  layout,
profile_view< P, Role >  view 
)
inlineprivate

Member Function Documentation

◆ active()

template<class P , stream_role Role>
bool everett::mapped_profile< P, Role >::active ( ) const
inlinenoexcept

◆ from_slice()

template<class P , stream_role Role>
static mapped_profile everett::mapped_profile< P, Role >::from_slice ( mapped_slice  source,
file_open_mode  mode = file_open_mode::checked 
)
inlinestatic

◆ layout() [1/2]

template<class P , stream_role Role>
section_detail::directory const & everett::mapped_profile< P, Role >::layout ( ) const &
inline

◆ layout() [2/2]

template<class P , stream_role Role>
section_detail::directory const & everett::mapped_profile< P, Role >::layout ( ) const &&
delete

◆ open() [1/2]

template<class P , stream_role Role>
static mapped_profile everett::mapped_profile< P, Role >::open ( file< P >  source)
inlinestatic

◆ open() [2/2]

template<class P , stream_role Role>
static mapped_profile everett::mapped_profile< P, Role >::open ( std::filesystem::path const &  path)
inlinestatic

◆ require_active()

template<class P , stream_role Role>
void everett::mapped_profile< P, Role >::require_active ( ) const
inlineprivate

◆ scan()

template<class P , stream_role Role>
void everett::mapped_profile< P, Role >::scan ( ) const
inline

◆ section() [1/2]

template<class P , stream_role Role>
std::span< std::byte const > everett::mapped_profile< P, Role >::section ( std::size_t  slot) const &
inline

◆ section() [2/2]

template<class P , stream_role Role>
std::span< std::byte const > everett::mapped_profile< P, Role >::section ( std::size_t  ) const &&
delete

◆ size()

template<class P , stream_role Role>
std::uint64_t everett::mapped_profile< P, Role >::size ( ) const
inline

◆ view() [1/2]

template<class P , stream_role Role>
profile_view< P, Role > everett::mapped_profile< P, Role >::view ( ) const &
inline

◆ view() [2/2]

template<class P , stream_role Role>
profile_view< P, Role > everett::mapped_profile< P, Role >::view ( ) const &&
delete

Member Data Documentation

◆ body_

template<class P , stream_role Role>
mapped_slice everett::mapped_profile< P, Role >::body_
private

◆ layout_

template<class P , stream_role Role>
section_detail::directory everett::mapped_profile< P, Role >::layout_
private

◆ source_

template<class P , stream_role Role>
file<P> everett::mapped_profile< P, Role >::source_
private

◆ view_

template<class P , stream_role Role>
profile_view<P, Role> everett::mapped_profile< P, Role >::view_
private

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