everett::file< P > Struct Template Reference

#include <file.h>

Public Types
using	policy_type = P

Public Member Functions
file_header< P >	header () const
mapped_slice	body () const
void	scan () const

Static Public Member Functions
static file	from_slice (mapped_slice bytes, file_open_mode mode=file_open_mode::checked)
static file	open (std::filesystem::path const &path, file_open_mode mode=file_open_mode::checked)

Private Member Functions
	file (mapped_slice bytes, std::optional< file_header< P > > header)

Static Private Member Functions
static file_header< P >	checked_header (mapped_slice const &bytes)

Private Attributes
mapped_slice	bytes_
std::optional< file_header< P > >	header_

Member Typedef Documentation

policy_type

template<class P >

using everett::file< P >::policy_type = P

Constructor & Destructor Documentation

file()

template<class P >

everett::file< P >::file ( mapped_slice  bytes, std::optional< file_header< P > >  header  )

inlineprivate

Member Function Documentation

body()

template<class P >

mapped_slice everett::file< P >::body ( ) const

inline

checked_header()

template<class P >

static file_header< P > everett::file< P >::checked_header ( mapped_slice const &  bytes )

inlinestaticprivate

from_slice()

template<class P >

static file everett::file< P >::from_slice ( mapped_slice  bytes, file_open_mode  mode = file_open_mode::checked  )

inlinestatic

header()

template<class P >

file_header< P > everett::file< P >::header ( ) const

inline

open()

template<class P >

static file everett::file< P >::open ( std::filesystem::path const &  path, file_open_mode  mode = file_open_mode::checked  )

inlinestatic

scan()

template<class P >

void everett::file< P >::scan ( ) const

inline

Member Data Documentation

bytes_

template<class P >

mapped_slice everett::file< P >::bytes_

private

header_

template<class P >

std::optional<file_header<P> > everett::file< P >::header_

private

---

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

• include/everett/file.h