MRUniqueTemporaryFolder.h File Reference

#include <MRCMisc/common.h>
#include <MRCMisc/exports.h>
#include <stdbool.h>
#include <stddef.h>

Go to the source code of this file.

Typedefs
typedef struct MR_std_filesystem_path	MR_std_filesystem_path
typedef struct MR_std_function_void_from_const_std_filesystem_path_ref	MR_std_function_void_from_const_std_filesystem_path_ref
typedef struct MR_UniqueTemporaryFolder	MR_UniqueTemporaryFolder

Functions
MRC_API MR_UniqueTemporaryFolder *	MR_UniqueTemporaryFolder_Construct (MR_PassBy onPreTempFolderDelete_pass_by, MR_std_function_void_from_const_std_filesystem_path_ref *onPreTempFolderDelete)
MRC_API MR_UniqueTemporaryFolder *	MR_UniqueTemporaryFolder_DefaultConstructArray (size_t num_elems)
MRC_API const MR_UniqueTemporaryFolder *	MR_UniqueTemporaryFolder_OffsetPtr (const MR_UniqueTemporaryFolder *ptr, ptrdiff_t i)
MRC_API MR_UniqueTemporaryFolder *	MR_UniqueTemporaryFolder_OffsetMutablePtr (MR_UniqueTemporaryFolder *ptr, ptrdiff_t i)
MRC_API MR_UniqueTemporaryFolder *	MR_UniqueTemporaryFolder_ConstructFromAnother (MR_PassBy _other_pass_by, MR_UniqueTemporaryFolder *_other)
MRC_API void	MR_UniqueTemporaryFolder_Destroy (const MR_UniqueTemporaryFolder *_this)
	Destroys a heap-allocated instance of MR_UniqueTemporaryFolder. Does nothing if the pointer is null.
MRC_API void	MR_UniqueTemporaryFolder_DestroyArray (const MR_UniqueTemporaryFolder *_this)
	Destroys a heap-allocated array of MR_UniqueTemporaryFolder. Does nothing if the pointer is null.
MRC_API bool	MR_UniqueTemporaryFolder_ConvertTo_bool (const MR_UniqueTemporaryFolder *_this)
MRC_API const MR_std_filesystem_path *	MR_UniqueTemporaryFolder_ConvertTo_const_std_filesystem_path_ref (const MR_UniqueTemporaryFolder *_this)
MRC_API MR_UniqueTemporaryFolder *	MR_UniqueTemporaryFolder_AssignFromAnother (MR_UniqueTemporaryFolder *_this, MR_PassBy _other_pass_by, MR_UniqueTemporaryFolder *_other)
MRC_API MR_std_filesystem_path *	MR_div_MR_UniqueTemporaryFolder_std_filesystem_path (const MR_UniqueTemporaryFolder *_this, const char *child, const char *child_end)

Typedef Documentation

MR_std_filesystem_path

typedef struct MR_std_filesystem_path MR_std_filesystem_path

MR_std_function_void_from_const_std_filesystem_path_ref

typedef struct MR_std_function_void_from_const_std_filesystem_path_ref MR_std_function_void_from_const_std_filesystem_path_ref

MR_UniqueTemporaryFolder

typedef struct MR_UniqueTemporaryFolder MR_UniqueTemporaryFolder

helper class to create a temporary folder; the folder will be removed on the object's destruction Generated from class MR::UniqueTemporaryFolder. Supported MR_PassBy modes: MR_PassBy_DefaultConstruct, MR_PassBy_Copy (and MR_PassBy_DefaultArgument and MR_PassBy_NoObject if supported by the callee).

Function Documentation

MR_div_MR_UniqueTemporaryFolder_std_filesystem_path()

MRC_API MR_std_filesystem_path * MR_div_MR_UniqueTemporaryFolder_std_filesystem_path	(	const MR_UniqueTemporaryFolder *	_this,
		const char *	child,
		const char *	child_end )

Generated from method MR::UniqueTemporaryFolder::operator/. Parameter _this can not be null. It is a single object. Parameter child is a UTF-8 encoded filesystem path. Never returns null. Returns an instance allocated on the heap! Must call MR_std_filesystem_path_Destroy() to free it when you're done using it.

MR_UniqueTemporaryFolder_AssignFromAnother()

MRC_API MR_UniqueTemporaryFolder * MR_UniqueTemporaryFolder_AssignFromAnother	(	MR_UniqueTemporaryFolder *	_this,
		MR_PassBy	_other_pass_by,
		MR_UniqueTemporaryFolder *	_other )

Generated from method MR::UniqueTemporaryFolder::operator=. Parameter _this can not be null. It is a single object. The reference to things referred to by the parameter _other (if any) might be preserved in this object. The returned pointer will never be null. It is non-owning, do NOT destroy it. When this function is called, this object will drop any object references it had previously.

MR_UniqueTemporaryFolder_Construct()

MRC_API MR_UniqueTemporaryFolder * MR_UniqueTemporaryFolder_Construct	(	MR_PassBy	onPreTempFolderDelete_pass_by,
		MR_std_function_void_from_const_std_filesystem_path_ref *	onPreTempFolderDelete )

creates new folder in temp directory Generated from constructor MR::UniqueTemporaryFolder::UniqueTemporaryFolder. Parameter onPreTempFolderDelete has a default argument: {}, pass MR_PassBy_DefaultArgument and a null pointer to use it. The reference to the parameter onPreTempFolderDelete might be preserved in the constructed object. Never returns null. Returns an instance allocated on the heap! Must call MR_UniqueTemporaryFolder_Destroy() to free it when you're done using it.

MR_UniqueTemporaryFolder_ConstructFromAnother()

MRC_API MR_UniqueTemporaryFolder * MR_UniqueTemporaryFolder_ConstructFromAnother	(	MR_PassBy	_other_pass_by,
		MR_UniqueTemporaryFolder *	_other )

Generated from constructor MR::UniqueTemporaryFolder::UniqueTemporaryFolder. The reference to things referred to by the parameter _other (if any) might be preserved in the constructed object. Never returns null. Returns an instance allocated on the heap! Must call MR_UniqueTemporaryFolder_Destroy() to free it when you're done using it.

MR_UniqueTemporaryFolder_ConvertTo_bool()

MRC_API bool MR_UniqueTemporaryFolder_ConvertTo_bool

(

const MR_UniqueTemporaryFolder *

_this

)

Generated from conversion operator MR::UniqueTemporaryFolder::operator bool. Parameter _this can not be null. It is a single object.

MR_UniqueTemporaryFolder_ConvertTo_const_std_filesystem_path_ref()

MRC_API const MR_std_filesystem_path * MR_UniqueTemporaryFolder_ConvertTo_const_std_filesystem_path_ref

(

const MR_UniqueTemporaryFolder *

_this

)

Generated from conversion operator MR::UniqueTemporaryFolder::operator const std::filesystem::path &. Parameter _this can not be null. It is a single object. The returned pointer will never be null. It is non-owning, do NOT destroy it.

MR_UniqueTemporaryFolder_DefaultConstructArray()

MRC_API MR_UniqueTemporaryFolder * MR_UniqueTemporaryFolder_DefaultConstructArray

(

size_t

num_elems

)

Constructs an array of empty (default-constructed) instances, of the specified size. Will never return null. The array must be destroyed using MR_UniqueTemporaryFolder_DestroyArray(). Use MR_UniqueTemporaryFolder_OffsetMutablePtr() and MR_UniqueTemporaryFolder_OffsetPtr() to access the array elements.

MR_UniqueTemporaryFolder_Destroy()

MRC_API void MR_UniqueTemporaryFolder_Destroy

(

const MR_UniqueTemporaryFolder *

_this

)

Destroys a heap-allocated instance of MR_UniqueTemporaryFolder. Does nothing if the pointer is null.

MR_UniqueTemporaryFolder_DestroyArray()

MRC_API void MR_UniqueTemporaryFolder_DestroyArray

(

const MR_UniqueTemporaryFolder *

_this

)

Destroys a heap-allocated array of MR_UniqueTemporaryFolder. Does nothing if the pointer is null.

MR_UniqueTemporaryFolder_OffsetMutablePtr()

MRC_API MR_UniqueTemporaryFolder * MR_UniqueTemporaryFolder_OffsetMutablePtr	(	MR_UniqueTemporaryFolder *	ptr,
		ptrdiff_t	i )

Offsets a pointer to an array element by i positions (not bytes). Use only if you're certain that the pointer points to an array element. The reference to the parameter ptr might be preserved in the return value.

MR_UniqueTemporaryFolder_OffsetPtr()

MRC_API const MR_UniqueTemporaryFolder * MR_UniqueTemporaryFolder_OffsetPtr	(	const MR_UniqueTemporaryFolder *	ptr,
		ptrdiff_t	i )

Offsets a pointer to an array element by i positions (not bytes). Use only if you're certain that the pointer points to an array element. The reference to the parameter ptr might be preserved in the return value.