utils5ext Namespace Reference

Namespaces
namespace	exceptions
	namespace to collect special exceptions for file operations.

Classes
class	File
class	FileRingBuffer

Typedefs
using	FilePos = int64_t
	Type for a file position.
using	FileSize = FilePos
	Type for the file size.
typedef int	FileHandle
	The type FileHandle is used internally only.

Functions
a_util::datetime::DateTime	getTimeAccess (const a_util::filesystem::Path filename)
	This function returns the last access time of the file.
a_util::datetime::DateTime	getTimeCreation (const a_util::filesystem::Path filename)
	This function returns the creation time of the file.
a_util::datetime::DateTime	getTimeChange (const a_util::filesystem::Path filename)
	This function returns the last change (write) time of the file.
size_t	getDefaultSectorSize () noexcept
	Get the Default Sector Size.
void *	allocPageAlignedMemory (size_t size, size_t page_size)
	allocates a memory buffer for the size of size (in bytes), page aligned in size to page_size
void	freePageAlignedMemory (void *memory)
	frees the memory buffer allocated with utils5ext::allocPageAlignedMemory
size_t	getSectorSizeFor (const a_util::filesystem::Path &filename) noexcept
	Get the sector size of a file within windows file system.
void	memZero (void *data, size_t bytes)
	Helper function to set a memory buffer to zero.
void	fileRename (const a_util::filesystem::Path &from, const a_util::filesystem::Path &to)
	Renames or moves a file.

Detailed Description

Namespace for Utils5 Extension utilities.

The Utils5 Extension package will provide some further helper classes needed to create an indexed file (ifhd).

Function Documentation

allocPageAlignedMemory()

void * utils5ext::allocPageAlignedMemory	(	size_t	size,
		size_t	page_size )

allocates a memory buffer for the size of size (in bytes), page aligned in size to page_size

Parameters

size	the size in bytes to allocate and to use
page_size	the page size the buffer will be aligned to in size

Returns

void* the buffer

Remarks

if allocated with allocPageAlignedMemory you must free the buffer with utils5ext::freePageAlignedMemory

fileRename()

void utils5ext::fileRename	(	const a_util::filesystem::Path &	from,
		const a_util::filesystem::Path &	to )

Renames or moves a file.

Parameters

from	the file to rename or move
to	the destination file

Exceptions

exceptions::ErrorFileAccess

freePageAlignedMemory()

void utils5ext::freePageAlignedMemory

(

void *

memory

)

frees the memory buffer allocated with utils5ext::allocPageAlignedMemory

Parameters

memory

the memory buffer

getDefaultSectorSize()

size_t utils5ext::getDefaultSectorSize ( )

noexcept

Get the Default Sector Size.

Returns

size_t the default sector size

getSectorSizeFor()

size_t utils5ext::getSectorSizeFor ( const a_util::filesystem::Path & filename )

noexcept

Get the sector size of a file within windows file system.

Parameters

filename

the filename to retrieve the sector size from

Returns

size_t the sector size.

Remarks

this function returns the getDefaultSectorSize() within linux!

getTimeAccess()

a_util::datetime::DateTime utils5ext::getTimeAccess

(

const a_util::filesystem::Path

filename

)

This function returns the last access time of the file.

Parameters

filename

Filename of the file to be checked

Returns

OK if the time has been retrieved, ERR_INVALID_ARG if filename is empty, ERR_UNKNOWN if time cannot be read;

Attention

From MSDN chapter "File Times": Not all file systems can record creation and last access times, and not all file systems record them in the same manner.
For example, the resolution of create time on FAT is 10 milliseconds, while write time has a resolution of 2 seconds and access time has a resolution of 1 day, so it is really the access date.
The NTFS file system delays updates to the last access time for a file by up to 1 hour after the last access.

Exceptions

exceptions::ErrorFileAccess,throw

std::runtime_error

getTimeChange()

a_util::datetime::DateTime utils5ext::getTimeChange

(

const a_util::filesystem::Path

filename

)

This function returns the last change (write) time of the file.

Parameters

filename

Filename of the file to be checked

Returns

OK if the time has been retrieved, ERR_INVALID_ARG if filename is empty, ERR_UNKNOWN if time cannot be read;

Attention

From MSDN chapter "File Times": Not all file systems can record creation and last access times, and not all file systems record them in the same manner.
For example, the resolution of create time on FAT is 10 milliseconds, while write time has a resolution of 2 seconds and access time has a resolution of 1 day, so it is really the access date.
The NTFS file system delays updates to the last access time for a file by up to 1 hour after the last access.

Exceptions

exceptions::ErrorFileAccess,throw

std::runtime_error

getTimeCreation()

a_util::datetime::DateTime utils5ext::getTimeCreation

(

const a_util::filesystem::Path

filename

)

This function returns the creation time of the file.

Parameters

filename

Filename of the file to be checked

Returns

OK if the time has been retrieved, ERR_INVALID_ARG if filename is empty, ERR_UNKNOWN if time cannot be read;

Attention

From MSDN chapter "File Times": Not all file systems can record creation and last access times, and not all file systems record them in the same manner.
For example, the resolution of create time on FAT is 10 milliseconds, while write time has a resolution of 2 seconds and access time has a resolution of 1 day, so it is really the access date.
The NTFS file system delays updates to the last access time for a file by up to 1 hour after the last access.

Exceptions

exceptions::ErrorFileAccess,throw

std::runtime_error

memZero()

void utils5ext::memZero ( void * data, size_t bytes )

inline

Helper function to set a memory buffer to zero.

Parameters

data	the buffer
bytes	the buffer size in bytes.