tt::file_view Class Reference

#include <ttauri/file_view.hpp>

Inheritance diagram for tt::file_view:

Public Member Functions
	file_view (std::shared_ptr< file_mapping > const &mappingObject, size_t offset, size_t size)
	file_view (URL const &location, access_mode accessMode=access_mode::open_for_read, size_t offset=0, size_t size=0)
	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
access_mode	accessMode () const noexcept
URL const &	location () const noexcept
size_t	offset () const noexcept override
size_t	size () const noexcept override
std::byte *	data () noexcept
std::byte const *	data () const noexcept override
std::span< std::byte >	bytes () noexcept
std::span< std::byte const >	bytes () const noexcept override
std::string_view	string_view () noexcept
std::string_view	string_view () const noexcept override
void	flush (void *base, size_t size)
	Flush changes in memory to the open file.
Public Member Functions inherited from tt::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
	operator std::span< std::byte const > () const noexcept

Static Public Member Functions
static std::unique_ptr< resource_view >	loadView (URL const &location)

Detailed Description

Map a file into virtual memory.

Member Function Documentation

accessMode()

access_mode tt::file_view::accessMode ( ) const

inlinenoexcept

Access mode of the opened file.

bytes() [1/2]

std::span< std::byte const > tt::file_view::bytes ( ) const

inlineoverridevirtualnoexcept

Span to the mapping into memory.

Implements tt::resource_view.

bytes() [2/2]

std::span< std::byte > tt::file_view::bytes ( )

inlinenoexcept

Span to the mapping into memory.

data() [1/2]

std::byte const * tt::file_view::data ( ) const

inlineoverridevirtualnoexcept

Pointer to the mapping into memory.

Implements tt::resource_view.

data() [2/2]

std::byte * tt::file_view::data ( )

inlinenoexcept

Pointer to the mapping into memory.

flush()

void tt::file_view::flush	(	void *	base,
		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.

loadView()

static std::unique_ptr< resource_view > tt::file_view::loadView ( URL const & location )

inlinestatic

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

location()

URL const & tt::file_view::location ( ) const

inlinenoexcept

URL location to the file.

offset()

size_t tt::file_view::offset ( ) const

inlineoverridevirtualnoexcept

Offset of the mapping into the file.

Implements tt::resource_view.

size()

size_t tt::file_view::size ( ) const

inlineoverridevirtualnoexcept

Number of bytes which is mapped to memory.

Implements tt::resource_view.

string_view() [1/2]

std::string_view tt::file_view::string_view ( ) const

inlineoverridevirtualnoexcept

String view to the mapping into memory.

Implements tt::resource_view.

string_view() [2/2]

std::string_view tt::file_view::string_view ( )

inlinenoexcept

String view to the mapping into memory.

---

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

• hikogui/src/ttauri/file_view.hpp