pulp::runtime::MemoryMappedFile Class Reference

#include <memory_mapped_file.hpp>

Public Member Functions
	MemoryMappedFile ()=default
	~MemoryMappedFile ()
bool	open (std::string_view path, MapMode mode=MapMode::ReadOnly)
bool	open (std::string_view path, MapMode mode, std::size_t maximum_bytes)
bool	open_no_follow (std::string_view path, MapMode mode, std::size_t maximum_bytes)
void	close ()
const uint8_t *	data () const
uint8_t *	mutable_data ()
size_t	size () const
bool	is_open () const
bool	copy_access_policy_to (std::string_view destination) const noexcept
AccessPolicyTarget	prepare_access_policy_target (std::string_view destination) const noexcept
bool	path_refers_to_open_file (std::string_view path) const noexcept
FileIdentity	opened_file_identity () const noexcept
bool	copy_contents_to_new_file (std::string_view destination) const noexcept
	MemoryMappedFile (const MemoryMappedFile &)=delete
MemoryMappedFile &	operator= (const MemoryMappedFile &)=delete
	MemoryMappedFile (MemoryMappedFile &&other) noexcept
MemoryMappedFile &	operator= (MemoryMappedFile &&other) noexcept

Constructor & Destructor Documentation

MemoryMappedFile() [1/3]

pulp::runtime::MemoryMappedFile::MemoryMappedFile ( )

default

~MemoryMappedFile()

pulp::runtime::MemoryMappedFile::~MemoryMappedFile

(

)

MemoryMappedFile() [2/3]

pulp::runtime::MemoryMappedFile::MemoryMappedFile ( const MemoryMappedFile & )

delete

MemoryMappedFile() [3/3]

pulp::runtime::MemoryMappedFile::MemoryMappedFile ( MemoryMappedFile && other )

noexcept

Member Function Documentation

close()

void pulp::runtime::MemoryMappedFile::close

(

)

copy_access_policy_to()

bool pulp::runtime::MemoryMappedFile::copy_access_policy_to ( std::string_view destination ) const

noexcept

copy_contents_to_new_file()

bool pulp::runtime::MemoryMappedFile::copy_contents_to_new_file ( std::string_view destination ) const

noexcept

data()

const uint8_t * pulp::runtime::MemoryMappedFile::data ( ) const

inline

is_open()

bool pulp::runtime::MemoryMappedFile::is_open ( ) const

inline

mutable_data()

uint8_t * pulp::runtime::MemoryMappedFile::mutable_data ( )

inline

open() [1/2]

bool pulp::runtime::MemoryMappedFile::open	(	std::string_view	path,
		MapMode	mode,
		std::size_t	maximum_bytes )

open() [2/2]

bool pulp::runtime::MemoryMappedFile::open	(	std::string_view	path,
		MapMode	mode = MapMode::ReadOnly )

open_no_follow()

bool pulp::runtime::MemoryMappedFile::open_no_follow	(	std::string_view	path,
		MapMode	mode,
		std::size_t	maximum_bytes )

opened_file_identity()

FileIdentity pulp::runtime::MemoryMappedFile::opened_file_identity ( ) const

noexcept

operator=() [1/2]

MemoryMappedFile & pulp::runtime::MemoryMappedFile::operator= ( const MemoryMappedFile & )

delete

operator=() [2/2]

MemoryMappedFile & pulp::runtime::MemoryMappedFile::operator= ( MemoryMappedFile && other )

noexcept

path_refers_to_open_file()

bool pulp::runtime::MemoryMappedFile::path_refers_to_open_file ( std::string_view path ) const

noexcept

prepare_access_policy_target()

AccessPolicyTarget pulp::runtime::MemoryMappedFile::prepare_access_policy_target ( std::string_view destination ) const

noexcept

size()

size_t pulp::runtime::MemoryMappedFile::size ( ) const

inline

---

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

• /home/runner/work/pulp/pulp/core/runtime/include/pulp/runtime/memory_mapped_file.hpp