#include <File.h>

Inheritance diagram for File:

Collaboration diagram for File:

Public Types
enum	OpenMode : uint01 { e_binary_read , e_binary_write , e_ascii_read , e_ascii_write , e_ascii_read_safe , e_binary_read_safe , e_ascii_write_safe , e_binary_write_safe , e_ascii_read_shared , e_undefined }

enum	CompressionMode { e_no_compression = 0 , e_best_speed_compression = 1 , e_best_compression = 9 , e_default_compression = -1 }

enum	FilePart { e_drive = 0x01 , e_dir_path = 0x02 , e_file_name = 0x04 , e_file_extension = 0x08 , e_full_path = e_drive \| e_dir_path \| e_file_name \| e_file_extension , e_folder_name = 0x10 }

Public Member Functions
NDEVR_BASE_API	File ()

NDEVR_BASE_API	File (const File &file)

NDEVR_BASE_API	File (const String &resource_name, const String &path_id)

NDEVR_BASE_API	File (File &&file) noexcept

NDEVR_BASE_API	File (const String &full_path)

NDEVR_BASE_API	File (String &&full_path)

NDEVR_BASE_API	File (const char *full_path)

NDEVR_BASE_API	~File ()

NDEVR_BASE_API bool	copyTo (const File &cs, bool override_file, ProgressInfo *log=nullptr) const

NDEVR_BASE_API bool	moveTo (File &file, bool override_file, ProgressInfo *log=nullptr, bool is_source_temp=false)

NDEVR_BASE_API File &	appendPath (const String &cs)

NDEVR_BASE_API String	getPath (uint01 file_parts) const

NDEVR_BASE_API void	setPath (const String &path, uint01 part)

NDEVR_BASE_API void	removeInvalidChars ()

NDEVR_BASE_API bool	exists () const

NDEVR_BASE_API bool	cachedExist () const

NDEVR_BASE_API bool	parentDirectoryExists () const

NDEVR_BASE_API bool	isDirectory () const

NDEVR_BASE_API bool	isDrive () const

NDEVR_BASE_API bool	isHidden () const

NDEVR_BASE_API bool	isOpen () const

NDEVR_BASE_API Buffer< uint01 >	getData ()

NDEVR_BASE_API String	getFolderName () const

NDEVR_BASE_API String	getDriveDescription () const

NDEVR_BASE_API Time	getModifiedTime () const

NDEVR_BASE_API Time	getCreationTime () const

NDEVR_BASE_API Time	getAccessTime () const

NDEVR_BASE_API void	getFileTimes (Time &modified_time, Time &creation_time, Time &access_time) const

NDEVR_BASE_API bool	updateAccessedTime () const

NDEVR_BASE_API bool	updateAccessedTime (Time access_time) const

NDEVR_BASE_API File &	append (const String &s)

NDEVR_BASE_API File &	append (const char &s)

NDEVR_BASE_API File	getParentDirectory () const

NDEVR_BASE_API File	findNonExistingSuitableName () const

NDEVR_BASE_API void	expandEnvironmentalVars ()

NDEVR_BASE_API Buffer< File, uint04, ObjectAllocator< false > >	getChildren () const

NDEVR_BASE_API Buffer< File, uint04, ObjectAllocator< false > >	getChildrenMatching (const Buffer< String > &include_patterns, const Buffer< String > &exclude_patterns, bool recursive=false) const

NDEVR_BASE_API FILE *	filePtr ()

NDEVR_BASE_API FILE *	open (OpenMode mode, bool append=false)

NDEVR_BASE_API String	relativePathTo (const File &reference) const

NDEVR_BASE_API void	flush ()

NDEVR_BASE_API void	close ()

NDEVR_BASE_API bool	hasNullBytes (uint08 max_length=Constant< uint08 >::Max)

NDEVR_BASE_API void	create (bool override_file) const

NDEVR_BASE_API void	deleteFile (ProgressInfo *log=nullptr)

NDEVR_BASE_API void	throwIfNotExist () const

NDEVR_BASE_API uint08	fileSize () const

NDEVR_BASE_API UUID	getUUID () const

NDEVR_BASE_API File &	operator= (const File &value)

NDEVR_BASE_API bool	operator<< (const String &value)

NDEVR_BASE_API bool	operator<< (const Buffer< uint01 > &values)

NDEVR_BASE_API bool	operator<< (const fltp04 &value)

NDEVR_BASE_API bool	operator<< (const fltp08 &value)

NDEVR_BASE_API File &	operator= (String &value)

NDEVR_BASE_API File &	operator= (File &&value) noexcept

NDEVR_BASE_API void	setInternalVars ()

NDEVR_BASE_API File	generateTempFile () const

const String &	pathID () const

String	pathNameID () const

NDEVR_BASE_API bool	isMTP () const

NDEVR_BASE_API bool	resolveMTPPath () const

NDEVR_BASE_API bool	resolveNameFromMTPPath ()

NDEVR_BASE_API void	invalidateCache ()

NDEVR_BASE_API void	updateCache () const

NDEVR_BASE_API const FileCachedData &	currentCache () const

NDEVR_BASE_API void	updateCache (const FileCachedData &cache)

NDEVR_BASE_API String	toDisplayString ()

NDEVR_BASE_API void	setFromDisplayString (const String &display_string)

size_t	operator() () const

Public Member Functions inherited from String
NDEVR_BASE_API	String ()

NDEVR_BASE_API	String (const String &string)

NDEVR_BASE_API	String (String &&string) noexcept

template<std::size_t N>
	String (const char(&string)[N])

template<std::size_t N>
	String (const wchar(&string)[N])

	String (const char *string)

NDEVR_BASE_API	String (const char *const string, uint04 size)

	String (uint04 size, const char &value)

template<class t_type >
	String (const t_type &value)

NDEVR_BASE_API bool	beginsWith (const String &s, bool ignore_case=false) const

NDEVR_BASE_API bool	endsWith (const String &s, bool ignore_case=false) const

NDEVR_BASE_API uint04	indexOf (const String &sub_string, bool ignore_case=false, uint04 start_index=0) const

NDEVR_BASE_API uint04	indexOf (const char &sub_string) const

NDEVR_BASE_API uint04	indexOf (const char &sub_string, uint04 start_pos) const

NDEVR_BASE_API uint04	indexOf (const char &sub_string, uint04 start_pos, uint04 size) const

NDEVR_BASE_API uint04	indexOf (const char *sub_string, bool ignore_case=false, uint04 start_index=0) const

NDEVR_BASE_API uint04	indexOf (const char *sub_string, bool ignore_case, uint04 start_index, uint04 size) const

NDEVR_BASE_API uint04	indexOf (const char *sub_string, char escape_char, bool ignore_case=false, uint04 start_index=0) const

NDEVR_BASE_API uint04	lastIndexOf (const char *sub_string, bool ignore_case=false) const

NDEVR_BASE_API uint04	lastIndexOf (const char value, bool ignore_case=false) const

NDEVR_BASE_API bool	hasSubString (const String &sub_string, bool ignore_case=false) const

NDEVR_BASE_API bool	hasSubString (const char *sub_string, bool ignore_case=false) const

NDEVR_BASE_API String &	replace (const String &sub_string, const String &replace_sub_string, bool ignore_case=false)

NDEVR_BASE_API String &	replace (const Buffer< String, uint04, ObjectAllocator< false > > &sub_string, const Buffer< String, uint04, ObjectAllocator< false > > &replace_sub_string, bool ignore_case=false)

NDEVR_BASE_API Buffer< String, uint04, ObjectAllocator< false > >	splitString (char delimiter, bool preserve_empty=true) const

NDEVR_BASE_API Buffer< String, uint04, ObjectAllocator< false > >	splitString (const Buffer< char > &delimiter, bool preserve_empty=true) const

NDEVR_BASE_API void	splitString (char delimiter, Buffer< String, uint04, ObjectAllocator< false > > &strings, bool preserve_empty=true) const

NDEVR_BASE_API void	splitString (const Buffer< char > &delimiter, Buffer< String, uint04, ObjectAllocator< false > > &strings, bool preserve_empty=true) const

NDEVR_BASE_API Buffer< String, uint04, ObjectAllocator< false > >	splitStringLength (uint04 max_chars_per_line) const

NDEVR_BASE_API Buffer< String, uint04, ObjectAllocator< false > >	splitStringLength (fltp04 length, fltp04(&font_width)[256]) const

NDEVR_BASE_API const char *	c_str () const

NDEVR_BASE_API bool	isSameNoCase (const String &s) const

NDEVR_BASE_API bool	matchesWildcard (const String &pattern) const

NDEVR_BASE_API String &	append (const String &string)

NDEVR_BASE_API uint08	hash () const

NDEVR_BASE_API uint08	hashUpper () const

NDEVR_BASE_API uint08	hashLower () const

	operator uint08 () const

	operator uint04 () const

size_t	operator() () const

NDEVR_BASE_API String	substr (uint04 start) const

NDEVR_BASE_API String	substr (uint04 start, uint04 end) const

NDEVR_BASE_API String &	trimWhiteSpace ()

NDEVR_BASE_API String &	addWhiteSpace (uint04 desired_string_size, uint04 desired_right_alignment_location=0, char whitespace=' ')

NDEVR_BASE_API String &	formatNumberString (uint04 decimals)

NDEVR_BASE_API String &	formatNumberString (bool add_comma, uint04 decimals)

NDEVR_BASE_API String &	formatNumberString (bool add_comma, uint04 min_decimals, uint04 max_decimals, uint04 min_digits, char decimal='.', char comma=',')

NDEVR_BASE_API String	formatTitleString () const

NDEVR_BASE_API String &	removeNonAlphaNumeric (bool remove_tab=true, bool remove_space=true, bool remove_new_line=true, bool remove_r=true, bool remove_numbers=false)

NDEVR_BASE_API String &	removeNonNumeric ()

NDEVR_BASE_API String	shortenString (uint04 size) const

NDEVR_BASE_API String	insertNewLines (uint04 max_line_size) const

NDEVR_BASE_API String	predictNextStringIncrement () const

NDEVR_BASE_API String	toUpper () const

NDEVR_BASE_API String	toLower () const

NDEVR_BASE_API bool	isNumeric () const

NDEVR_BASE_API uint04	fromHex () const

NDEVR_BASE_API void	addUnicodeAsUTF8 (const wchar *unicode)

NDEVR_BASE_API bool	addUnicodeCharAsUTF8 (const wchar *unicode, uint04 &advance)

void	addWChar (const wchar &object)

String &	operator= (const String &value)

String &	operator= (String &&value) noexcept

bool	operator== (const String &value) const

bool	operator== (const char *const value) const

template<std::size_t t_size>
bool	operator== (const char(&string)[t_size])

bool	operator!= (const char *const value) const

template<std::size_t t_size>
bool	operator!= (const char(&string)[t_size])

bool	operator!= (const String &value) const

template<class t_type >
t_type	getAs () const

NDEVR_BASE_API bool	operator< (const String &value) const

NDEVR_BASE_API bool	operator> (const String &value) const

Public Member Functions inherited from Buffer< char, uint04, ObjectAllocator< true >, BufferAllocator< char, uint04, true > >
constexpr	Buffer ()

constexpr	Buffer (const Buffer &buffer)

constexpr	Buffer (Buffer &&buffer) noexcept

	Buffer (uint04 size)

	Buffer (const char *buffer, uint04 size)

	Buffer (uint04 size, const char &fill_object)

	Buffer (std::initializer_list< char > l)

	Buffer (const t_iterator &begin, const t_iterator &end)

	~Buffer ()

	operator const char * () const

	operator char * ()

Buffer< t_other_type, t_other_index_type, t_other_memory_allocator, t_other_memory_manager >	getAs () const

void	add (char &&object)

void	add (const char &object)

void	add (uint04 location, const char &object)

void	add (uint04 location, char &&object)

void	addAll (const Buffer< char, t_other_index_type, t_other_memory_allocator, t_other_memory_manager > &buffer)

void	addAll (const char *buffer, uint04 buffer_size)

void	addAll (const char *buffer)

void	insert (uint04 offset, const Buffer &buffer)

void	insert (uint04 offset, const char *const buffer, uint04 buffer_size)

void	insert (const uint04 location, const char *buffer)

void	replaceIndexRange (uint04 offset, uint04 replace_size, const Buffer &buffer)

void	addSpace (uint04 space_to_add)

void	addSpace (uint04 location, uint04 size)

void	addAndFillSpace (uint04 space_to_add, const char &fill_object)

decltype(auto)	ptr ()

decltype(auto)	ptr () const

uint04	memSize () const

decltype(auto)	begin ()

decltype(auto)	begin () const

decltype(auto)	begin (uint04 index) const

uint04	capacity () const

void	clear ()

void	clear (uint04 new_capacity)

sint04	compare (const Buffer &value) const

sint04	compare (const Buffer &value, uint04 start, uint04 end) const

bool	contains (const char &element) const

bool	contains (const char &element, const std::function< bool(const char &, const char &)> &equal_function) const

bool	contains (const char &element, uint04 start) const

bool	contains (const char &element, uint04 start, uint04 search_size) const

uint04	count (const char &element) const

decltype(auto)	end ()

decltype(auto)	end () const

decltype(auto)	end (uint04 index)

void	ensureCapacity (uint04 new_capacity, bool ensure_not_greater=false, bool ensure_not_less=true)

bool	equals (const Buffer &buffer) const

decltype(auto)	get (uint04 index)

decltype(auto)	get (uint04 index) const

Buffer	getAll (uint04 start, uint04 size)

uint04	indexOf (const char &element) const

uint04	indexOf (const char &element, uint04 start_pos) const

uint04	indexOf (const char &element, uint04 start_pos, uint04 search_size) const

bool	isEmpty () const

decltype(auto)	last ()

decltype(auto)	last () const

uint04	lastIndexOf (const char &element) const

void	removeIndex (uint04 location)

void	removeIndexBackSwap (uint04 location)

bool	removeElement (const char &element)

void	removeLast ()

void	removeAllUnordered (const char &object)

void	removeAllUnordered (const t_functor &functor)

void	removeAllOrdered (const char &object)

void	removeAllIndex (uint04 start, uint04 end)

void	removeAllIndices (const t_range_buffer &ranges)

void	replaceAll (const char &var, const char &replacement)

void	reverse ()

void	reverse (const uint04 start, const uint04 end)

void	setAll (const t_o_type *src, uint04 offset, uint04 size)

void	setAll (const Buffer &buffer, uint04 offset, uint04 size)

void	setAll (const Buffer &buffer, uint04 offset, uint04 other_offset, uint04 size)

void	setAllToValue (const t_o_type &fill_element, const uint04 offset=0, uint04 fill_size=Constant< uint04 >::NaN)

void	setSize (uint04 new_size)

void	setSize (const uint04 new_size, const char &fill_element)

void	resize (uint04 new_size)

constexpr uint04	size () const

void	swapElements (const char &element1, const char &element2)

void	swapAllElements (const char &element1, const char &element2)

void	swapIndices (uint04 index_1, uint04 index_2)

void	move (uint04 from, uint04 to)

void	primitiveSort ()

void	sort ()

void	sortRange (uint04 start, uint04 end)

void	setUnique ()

void	setUniquePresorted ()

uint04	sortAboutValue (uint04 value_index)

uint04	sortAboutValue (uint04 value_index, uint04 start, uint04 end)

Buffer &	operator= (const Buffer &buffer)

Buffer &	operator= (Buffer &&buffer) noexcept

bool	operator== (const Buffer &buffer) const

bool	operator> (const Buffer &buffer) const

bool	operator< (const Buffer &buffer) const

bool	operator>= (const Buffer &buffer) const

bool	operator<= (const Buffer &buffer) const

bool	operator!= (const Buffer &buffer) const

decltype(auto)	operator[] (const uint04 index)

decltype(auto)	operator[] (const int index)

decltype(auto)	operator[] (const uint04 value) const

decltype(auto)	operator[] (const int index) const

Buffer	operator+ (const char &element) const

Buffer	operator+ (const Buffer &value) const

const Buffer &	operator+= (const char &element)

Buffer &	operator+= (const Buffer &value)

bool	isSorted () const

bool	isSortedSet () const

constexpr BufferAllocator< char, uint04, true > &	memoryInterface ()

constexpr const BufferAllocator< char, uint04, true > &	memoryInterface () const

Static Public Member Functions
static NDEVR_BASE_API File	TempFileFolder ()

static NDEVR_BASE_API Buffer< File, uint04, ObjectAllocator< false > >	SystemDrives ()

static NDEVR_BASE_API Buffer< File, uint04, ObjectAllocator< false > >	MTPDevices ()

static NDEVR_BASE_API bool	doesFileExist (const String &name)

static NDEVR_BASE_API bool	typeSort (const File &i, const File &j)

static NDEVR_BASE_API bool	nameSort (const File &i, const File &j)

static NDEVR_BASE_API bool	accessSort (const File &i, const File &j)

static NDEVR_BASE_API bool	createSort (const File &i, const File &j)

static NDEVR_BASE_API bool	isPathSep (const char &path)

static NDEVR_BASE_API bool	isIDSep (const char &path)

Static Public Member Functions inherited from String
static NDEVR_BASE_API bool	AlphaNumericCompare (const String &left, const String &right)

template<class t_type >
static TranslatedString	DisplayString (const t_type &value)

static constexpr uint04	str_len (const char *value)

static constexpr uint04	str_len (const wchar *value)

static constexpr uint08	hash (const char *value)

static NDEVR_BASE_API bool	IsWhiteSpace (char s)

static NDEVR_BASE_API String	NumberString (fltp08 value, bool add_comma, uint04 min_decimals, uint04 max_decimals, uint04 min_digits, char decimal='.', char comma=',')

static NDEVR_BASE_API String	ConvertToCharString (uint04 number)

static NDEVR_BASE_API String	toHex (uint01 value)

static NDEVR_BASE_API String	toHex (char value)

static NDEVR_BASE_API wchar	UTF8toUnicode (const char *utf8, uint04 &advance)

static NDEVR_BASE_API String	UnicodetoUTF8 (const wchar *unicode, uint04 &advance)

template<class t_object >
static std::enable_if< ObjectInfo< t_object >::Integer, String >::type	toHex (t_object value)

template<class t_object , class t_allocator , class t_buff >
static String	toHex (const Buffer< t_object, t_allocator, t_buff > &values)

static String	toHex (const String &values)

template<uint01 t_size, class t_type >
static String	toHex (const Vector< t_size, t_type > &values)

Static Public Member Functions inherited from Buffer< char, uint04, ObjectAllocator< true >, BufferAllocator< char, uint04, true > >
static constexpr char	Type ()

Static Public Attributes
static constexpr char	PathSep = '/'

static constexpr char	ExtSep = '.'

static constexpr char	DriveSep = ':'

static constexpr char	IDSep = '\|'

static NDEVR_BASE_API String	PathSepS

Protected Attributes
FileCachedData	m_cached_data

String	m_id

FILE *	m_file_ptr

OpenMode	m_open_mode

uint01	m_path_start

uint01	m_file_name_start

uint01	m_file_ext_start

bool	m_id_valid

Protected Attributes inherited from Buffer< char, uint04, ObjectAllocator< true >, BufferAllocator< char, uint04, true > >
BufferAllocator< char, uint04, true >	m_memory_interface

Additional Inherited Members
Protected Member Functions inherited from Buffer< char, uint04, ObjectAllocator< true >, BufferAllocator< char, uint04, true > >
bool	_equals (const Buffer &buffer) const

Member Enumeration Documentation

◆ CompressionMode

enum CompressionMode

Enumerator
e_no_compression
e_best_speed_compression
e_best_compression
e_default_compression

◆ FilePart

enum FilePart

Enumerator
e_drive
e_dir_path
e_file_name
e_file_extension
e_full_path
e_folder_name

◆ OpenMode

enum OpenMode : uint01

Enumerator
e_binary_read
e_binary_write
e_ascii_read
e_ascii_write
e_ascii_read_safe
e_binary_read_safe
e_ascii_write_safe
e_binary_write_safe
e_ascii_read_shared
e_undefined

Constructor & Destructor Documentation

◆ File() [1/7]

File ( )

◆ File() [2/7]

File ( const File & file )

◆ File() [3/7]

File	(	const String &	resource_name,
		const String &	path_id )

◆ File() [4/7]

File ( File && file )

noexcept

◆ File() [5/7]

File ( const String & full_path )

◆ File() [6/7]

File ( String && full_path )

◆ File() [7/7]

File ( const char * full_path )

◆ ~File()

~File ( )

Member Function Documentation

◆ accessSort()

bool accessSort	(	const File &	i,
		const File &	j )

static

◆ append() [1/2]

File & append ( const char & s )

◆ append() [2/2]

File & append ( const String & s )

◆ appendPath()

File & appendPath ( const String & cs )

◆ cachedExist()

bool cachedExist ( ) const

nodiscard

◆ close()

void close ( )

◆ copyTo()

bool copyTo	(	const File &	cs,
		bool	override_file,
		ProgressInfo *	log = nullptr ) const

◆ create()

void create ( bool override_file ) const

◆ createSort()

bool createSort	(	const File &	i,
		const File &	j )

static

◆ currentCache()

const FileCachedData & currentCache ( ) const

◆ deleteFile()

void deleteFile ( ProgressInfo * log = nullptr )

◆ doesFileExist()

bool doesFileExist ( const String & name )

static

◆ exists()

bool exists ( ) const

nodiscard

◆ expandEnvironmentalVars()

void expandEnvironmentalVars ( )

◆ filePtr()

FILE * filePtr ( )

nodiscard

◆ fileSize()

uint08 fileSize ( ) const

nodiscard

◆ findNonExistingSuitableName()

File findNonExistingSuitableName ( ) const

◆ flush()

void flush ( )

◆ generateTempFile()

File generateTempFile ( ) const

nodiscard

◆ getAccessTime()

Time getAccessTime ( ) const

nodiscard

◆ getChildren()

Buffer< File > getChildren ( ) const

nodiscard

◆ getChildrenMatching()

Buffer< File > getChildrenMatching	(	const Buffer< String > &	include_patterns,
		const Buffer< String > &	exclude_patterns,
		bool	recursive = false ) const

nodiscard

◆ getCreationTime()

Time getCreationTime ( ) const

nodiscard

◆ getData()

Buffer< uint01 > getData ( )

nodiscard

◆ getDriveDescription()

String getDriveDescription ( ) const

nodiscard

◆ getFileTimes()

void getFileTimes	(	Time &	modified_time,
		Time &	creation_time,
		Time &	access_time ) const

◆ getFolderName()

String getFolderName ( ) const

nodiscard

◆ getModifiedTime()

Time getModifiedTime ( ) const

nodiscard

◆ getParentDirectory()

File getParentDirectory ( ) const

◆ getPath()

String getPath ( uint01 file_parts ) const

nodiscard

◆ getUUID()

UUID getUUID ( ) const

nodiscard

◆ hasNullBytes()

bool hasNullBytes ( uint08 max_length = Constant<uint08>::Max )

◆ invalidateCache()

void invalidateCache ( )

◆ isDirectory()

bool isDirectory ( ) const

nodiscard

◆ isDrive()

bool isDrive ( ) const

nodiscard

◆ isHidden()

bool isHidden ( ) const

nodiscard

◆ isIDSep()

bool isIDSep ( const char & path )

static

◆ isMTP()

bool isMTP ( ) const

◆ isOpen()

bool isOpen ( ) const

nodiscard

◆ isPathSep()

bool isPathSep ( const char & path )

static

◆ moveTo()

bool moveTo	(	File &	file,
		bool	override_file,
		ProgressInfo *	log = nullptr,
		bool	is_source_temp = false )

◆ MTPDevices()

Buffer< File > MTPDevices ( )

static

◆ nameSort()

bool nameSort	(	const File &	i,
		const File &	j )

static

◆ open()

FILE * open	(	OpenMode	mode,
		bool	append = false )

◆ operator()()

size_t operator() ( ) const

inline

◆ operator<<() [1/4]

bool operator<< ( const Buffer< uint01 > & values )

◆ operator<<() [2/4]

bool operator<< ( const fltp04 & value )

◆ operator<<() [3/4]

bool operator<< ( const fltp08 & value )

◆ operator<<() [4/4]

bool operator<< ( const String & value )

◆ operator=() [1/3]

File & operator= ( const File & value )

◆ operator=() [2/3]

File & operator= ( File && value )

noexcept

◆ operator=() [3/3]

File & operator= ( String & value )

◆ parentDirectoryExists()

bool parentDirectoryExists ( ) const

nodiscard

◆ pathID()

const String & pathID ( ) const

inline

◆ pathNameID()

String pathNameID ( ) const

◆ relativePathTo()

String relativePathTo ( const File & reference ) const

◆ removeInvalidChars()

void removeInvalidChars ( )

◆ resolveMTPPath()

bool resolveMTPPath ( ) const

◆ resolveNameFromMTPPath()

bool resolveNameFromMTPPath ( )

◆ setFromDisplayString()

void setFromDisplayString ( const String & display_string )

◆ setInternalVars()

void setInternalVars ( )

◆ setPath()

void setPath	(	const String &	path,
		uint01	part )

◆ SystemDrives()

Buffer< File > SystemDrives ( )

static

◆ TempFileFolder()

File TempFileFolder ( )

staticnodiscard

◆ throwIfNotExist()

void throwIfNotExist ( ) const

◆ toDisplayString()

String toDisplayString ( )

◆ typeSort()

bool typeSort	(	const File &	i,
		const File &	j )

static

◆ updateAccessedTime() [1/2]

bool updateAccessedTime ( ) const

◆ updateAccessedTime() [2/2]

bool updateAccessedTime ( Time access_time ) const

◆ updateCache() [1/2]

void updateCache ( ) const

◆ updateCache() [2/2]

void updateCache ( const FileCachedData & cache )

Member Data Documentation

◆ DriveSep

char DriveSep = ':'

staticconstexpr

◆ ExtSep

char ExtSep = '.'

staticconstexpr

◆ IDSep

char IDSep = '|'

staticconstexpr

◆ m_cached_data

FileCachedData m_cached_data

mutableprotected

◆ m_file_ext_start

uint01 m_file_ext_start

protected

◆ m_file_name_start

uint01 m_file_name_start

protected

◆ m_file_ptr

FILE* m_file_ptr

protected

◆ m_id

String m_id

mutableprotected

◆ m_id_valid

bool m_id_valid

mutableprotected

◆ m_open_mode

OpenMode m_open_mode

protected

◆ m_path_start

uint01 m_path_start

protected

◆ PathSep

char PathSep = '/'

staticconstexpr

◆ PathSepS

String PathSepS

static

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

Base/Headers/File.h
Base/Source/File.cpp

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Attributes

Additional Inherited Members

Member Enumeration Documentation

◆ CompressionMode

◆ FilePart

◆ OpenMode

Constructor & Destructor Documentation

◆ File() [1/7]

◆ File() [2/7]

◆ File() [3/7]

◆ File() [4/7]

◆ File() [5/7]

◆ File() [6/7]

◆ File() [7/7]

◆ ~File()

Member Function Documentation

◆ accessSort()

◆ append() [1/2]

◆ append() [2/2]

◆ appendPath()

◆ cachedExist()

◆ close()

◆ copyTo()

◆ create()

◆ createSort()

◆ currentCache()

◆ deleteFile()

◆ doesFileExist()

◆ exists()

◆ expandEnvironmentalVars()

◆ filePtr()

◆ fileSize()

◆ findNonExistingSuitableName()

◆ flush()

◆ generateTempFile()

◆ getAccessTime()

◆ getChildren()

◆ getChildrenMatching()

◆ getCreationTime()

◆ getData()

◆ getDriveDescription()

◆ getFileTimes()

◆ getFolderName()

◆ getModifiedTime()

◆ getParentDirectory()

◆ getPath()

◆ getUUID()

◆ hasNullBytes()

◆ invalidateCache()

◆ isDirectory()

◆ isDrive()

◆ isHidden()

◆ isIDSep()

◆ isMTP()

◆ isOpen()

◆ isPathSep()

◆ moveTo()

◆ MTPDevices()

◆ nameSort()

◆ open()

◆ operator()()

◆ operator<<() [1/4]

◆ operator<<() [2/4]

◆ operator<<() [3/4]

◆ operator<<() [4/4]

◆ operator=() [1/3]

◆ operator=() [2/3]

◆ operator=() [3/3]

◆ parentDirectoryExists()

◆ pathID()

◆ pathNameID()

◆ relativePathTo()

◆ removeInvalidChars()

◆ resolveMTPPath()

◆ resolveNameFromMTPPath()

◆ setFromDisplayString()