std_filesystem_path.h File Reference

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

Go to the source code of this file.

Typedefs
typedef struct MR_std_string	MR_std_string
typedef struct MR_std_filesystem_path	MR_std_filesystem_path

Functions
MRC_API MR_std_filesystem_path *	MR_std_filesystem_path_DefaultConstruct (void)
MRC_API MR_std_filesystem_path *	MR_std_filesystem_path_DefaultConstructArray (size_t num_elems)
MRC_API MR_std_filesystem_path *	MR_std_filesystem_path_ConstructFromAnother (MR_PassBy other_pass_by, MR_std_filesystem_path *other)
MRC_API MR_std_filesystem_path *	MR_std_filesystem_path_ConstructFrom (const char *other, const char *other_end)
MRC_API void	MR_std_filesystem_path_AssignFromAnother (MR_std_filesystem_path *_this, MR_PassBy other_pass_by, MR_std_filesystem_path *other)
MRC_API void	MR_std_filesystem_path_AssignFrom (MR_std_filesystem_path *_this, const char *other, const char *other_end)
MRC_API void	MR_std_filesystem_path_Destroy (const MR_std_filesystem_path *_this)
	Destroys a heap-allocated instance of MR_std_filesystem_path. Does nothing if the pointer is null.
MRC_API void	MR_std_filesystem_path_DestroyArray (const MR_std_filesystem_path *_this)
	Destroys a heap-allocated array of MR_std_filesystem_path. Does nothing if the pointer is null.
MRC_API const MR_std_filesystem_path *	MR_std_filesystem_path_OffsetPtr (const MR_std_filesystem_path *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.
MRC_API MR_std_filesystem_path *	MR_std_filesystem_path_OffsetMutablePtr (MR_std_filesystem_path *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.
MRC_API MR_std_string *	MR_std_filesystem_path_GetString (const MR_std_filesystem_path *_this)

Typedef Documentation

MR_std_filesystem_path

typedef struct MR_std_filesystem_path MR_std_filesystem_path

Stores a filesystem path. Supported MR_PassBy modes: MR_PassBy_DefaultConstruct, MR_PassBy_Copy, MR_PassBy_Move, (and MR_PassBy_DefaultArgument and MR_PassBy_NoObject if supported by the callee).

MR_std_string

typedef struct MR_std_string MR_std_string

Function Documentation

MR_std_filesystem_path_AssignFrom()

MRC_API void MR_std_filesystem_path_AssignFrom	(	MR_std_filesystem_path *	_this,
		const char *	other,
		const char *	other_end )

Assigns the contents. Parameter _this can not be null. It is a single object. Parameter other is a UTF-8 encoded filesystem path.

MR_std_filesystem_path_AssignFromAnother()

MRC_API void MR_std_filesystem_path_AssignFromAnother	(	MR_std_filesystem_path *	_this,
		MR_PassBy	other_pass_by,
		MR_std_filesystem_path *	other )

Assigns the contents from another instance. Both objects remain alive after the call. Parameter _this can not be null. It is a single object.

MR_std_filesystem_path_ConstructFrom()

MRC_API MR_std_filesystem_path * MR_std_filesystem_path_ConstructFrom	(	const char *	other,
		const char *	other_end )

Constructs a new instance. Parameter other 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_std_filesystem_path_ConstructFromAnother()

MRC_API MR_std_filesystem_path * MR_std_filesystem_path_ConstructFromAnother	(	MR_PassBy	other_pass_by,
		MR_std_filesystem_path *	other )

Constructs a copy of another instance. The source remains alive. 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_std_filesystem_path_DefaultConstruct()

MRC_API MR_std_filesystem_path * MR_std_filesystem_path_DefaultConstruct

(

void

)

Constructs an empty (default-constructed) instance. 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_std_filesystem_path_DefaultConstructArray()

MRC_API MR_std_filesystem_path * MR_std_filesystem_path_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_std_filesystem_path_DestroyArray(). Use MR_std_filesystem_path_OffsetMutablePtr() and MR_std_filesystem_path_OffsetPtr() to access the array elements.

MR_std_filesystem_path_Destroy()

MRC_API void MR_std_filesystem_path_Destroy

(

const MR_std_filesystem_path *

_this

)

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

MR_std_filesystem_path_DestroyArray()

MRC_API void MR_std_filesystem_path_DestroyArray

(

const MR_std_filesystem_path *

_this

)

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

MR_std_filesystem_path_GetString()

MRC_API MR_std_string * MR_std_filesystem_path_GetString

(

const MR_std_filesystem_path *

_this

)

Get the contents as a UTF8-encoded string. Parameter _this can not be null. It is a single object. Never returns null. Returns an instance allocated on the heap! Must call MR_std_string_Destroy() to free it when you're done using it.

MR_std_filesystem_path_OffsetMutablePtr()

MRC_API MR_std_filesystem_path * MR_std_filesystem_path_OffsetMutablePtr	(	MR_std_filesystem_path *	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.

MR_std_filesystem_path_OffsetPtr()

MRC_API const MR_std_filesystem_path * MR_std_filesystem_path_OffsetPtr	(	const MR_std_filesystem_path *	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.