v1::file_view Class Reference

#include <hikogui/file_view.hpp>

Inheritance diagram for v1::file_view:

Public Member Functions
	file_view (file_view const &other) noexcept
	file_view (file_view &&other) noexcept
file_view &	operator= (file_view const &other) noexcept
file_view &	operator= (file_view &&other) noexcept
	file_view (std::shared_ptr< file_mapping > const &mappingObject, std::size_t offset, std::size_t size)
	file_view (std::filesystem::path const &path, access_mode access_mode=access_mode::open_for_read, std::size_t offset=0, std::size_t size=0)
	file_view (URL path, access_mode access_mode=access_mode::open_for_read, std::size_t offset=0, std::size_t size=0)
	file_view (std::string_view path, access_mode access_mode=access_mode::open_for_read, std::size_t offset=0, std::size_t size=0)
	file_view (std::string const &path, access_mode access_mode=access_mode::open_for_read, std::size_t offset=0, std::size_t size=0)
	file_view (char const *path, access_mode access_mode=access_mode::open_for_read, std::size_t offset=0, std::size_t size=0)
access_mode	accessMode () const noexcept
std::filesystem::path const &	path () const noexcept
std::size_t	offset () const noexcept override
void_span	writable_span () noexcept override
const_void_span	span () const noexcept override
void	flush (void *base, std::size_t size)
	Flush changes in memory to the open file.
Public Member Functions inherited from v1::resource_view
	resource_view (resource_view const &other)=default
	resource_view (resource_view &&other)=default
resource_view &	operator= (resource_view const &other)=default
resource_view &	operator= (resource_view &&other)=default

Static Public Member Functions
static std::unique_ptr< resource_view >	load_view (std::filesystem::path const &path)

Detailed Description

Map a file into virtual memory.

Member Function Documentation

accessMode()

access_mode v1::file_view::accessMode ( ) const

inlinenoexcept

Access mode of the opened file.

flush()

void v1::file_view::flush	(	void *	base,
		std::size_t	size )

Flush changes in memory to the open file.

Parameters

base	Start location of the memory to flush.
size	Number of bytes from the base of the memory region to flush.

load_view()

static std::unique_ptr< resource_view > v1::file_view::load_view ( std::filesystem::path const & path )

inlinestatic

Load a view of a resource. This is used when the resource that needs to be opened is a file.

offset()

std::size_t v1::file_view::offset ( ) const

inlineoverridevirtualnoexcept

Offset of the mapping into the file.

Implements v1::resource_view.

path()

std::filesystem::path const & v1::file_view::path ( ) const

inlinenoexcept

URL location to the file.

span()

const_void_span v1::file_view::span ( ) const

inlineoverridevirtualnoexcept

Span to the mapping into memory.

Implements v1::resource_view.

writable_span()

void_span v1::file_view::writable_span ( )

inlineoverridevirtualnoexcept

Span to the mapping into memory.

Implements v1::writable_resource_view.

---

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

• hikogui/src/hikogui/file_view.hpp