tt::File Struct Reference

#include <TTauri/Foundation/File.hpp>

Public Member Functions
	File (URL const &location, AccessMode accessMode)
	File (File const &other)=delete
	File (File &&other)=delete
File &	operator= (File const &other)=delete
File &	operator= (File &&other)=delete
void	close ()
ssize_t	write (std::byte const *data, ssize_t size)
ssize_t	write (void const *data, ssize_t size)
ssize_t	write (char const *data, ssize_t size)
ssize_t	write (std::string_view text)

Static Public Member Functions
static size_t	fileSize (URL const &url)
static void	createDirectory (URL const &url, bool hierarchy=false)
static void	createDirectoryHierarchy (URL const &url)

Data Fields
AccessMode	accessMode
URL	location
FileHandle	fileHandle

Detailed Description

A File object.

Constructor & Destructor Documentation

File()

tt::File::File	(	URL const &	location,
		AccessMode	accessMode )

Open a file at location.

Parameters

location	The file: URL locating the file.
accessMode	access-mode to open the file.

Member Function Documentation

close()

void tt::File::close

(

)

Close the file.

fileSize()

static size_t tt::File::fileSize ( URL const & url )

static

Get the size of a file on the file system.

Returns

The size of the file in bytes.

write() [1/3]

ssize_t tt::File::write ( char const * data, ssize_t size )

inline

Write data to a file.

write() [2/3]

ssize_t tt::File::write	(	std::byte const *	data,
		ssize_t	size )

Write data to a file.

write() [3/3]

ssize_t tt::File::write ( void const * data, ssize_t size )

inline

Write data to a file.

Field Documentation

accessMode

AccessMode tt::File::accessMode

The access mode used to open the file.

fileHandle

FileHandle tt::File::fileHandle

A operating system handle to the file.

location

URL tt::File::location

The URL that was used to open the file.

---

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

• hikogui/src/TTauri/Foundation/File.hpp