std_optional_MR_Edges.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_Edges	MR_Edges
typedef struct MR_std_optional_MR_Edges	MR_std_optional_MR_Edges

Functions
MRC_API MR_std_optional_MR_Edges *	MR_std_optional_MR_Edges_DefaultConstruct (void)
MRC_API MR_std_optional_MR_Edges *	MR_std_optional_MR_Edges_DefaultConstructArray (size_t num_elems)
MRC_API MR_std_optional_MR_Edges *	MR_std_optional_MR_Edges_ConstructFromAnother (MR_PassBy other_pass_by, MR_std_optional_MR_Edges *other)
MRC_API MR_std_optional_MR_Edges *	MR_std_optional_MR_Edges_ConstructFrom (MR_PassBy other_pass_by, MR_Edges *other)
MRC_API void	MR_std_optional_MR_Edges_AssignFromAnother (MR_std_optional_MR_Edges *_this, MR_PassBy other_pass_by, MR_std_optional_MR_Edges *other)
MRC_API void	MR_std_optional_MR_Edges_AssignFrom (MR_std_optional_MR_Edges *_this, MR_PassBy other_pass_by, MR_Edges *other)
MRC_API void	MR_std_optional_MR_Edges_Destroy (const MR_std_optional_MR_Edges *_this)
	Destroys a heap-allocated instance of MR_std_optional_MR_Edges. Does nothing if the pointer is null.
MRC_API void	MR_std_optional_MR_Edges_DestroyArray (const MR_std_optional_MR_Edges *_this)
	Destroys a heap-allocated array of MR_std_optional_MR_Edges. Does nothing if the pointer is null.
MRC_API const MR_std_optional_MR_Edges *	MR_std_optional_MR_Edges_OffsetPtr (const MR_std_optional_MR_Edges *ptr, ptrdiff_t i)
MRC_API MR_std_optional_MR_Edges *	MR_std_optional_MR_Edges_OffsetMutablePtr (MR_std_optional_MR_Edges *ptr, ptrdiff_t i)
MRC_API const MR_Edges *	MR_std_optional_MR_Edges_Value (const MR_std_optional_MR_Edges *_this)
MRC_API MR_Edges *	MR_std_optional_MR_Edges_MutableValue (MR_std_optional_MR_Edges *_this)

Typedef Documentation

MR_Edges

typedef struct MR_Edges MR_Edges

MR_std_optional_MR_Edges

typedef struct MR_std_optional_MR_Edges MR_std_optional_MR_Edges

Stores either a single MR::Edges or nothing. 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).

Function Documentation

MR_std_optional_MR_Edges_AssignFrom()

MRC_API void MR_std_optional_MR_Edges_AssignFrom	(	MR_std_optional_MR_Edges *	_this,
		MR_PassBy	other_pass_by,
		MR_Edges *	other )

Assigns the contents. Parameter _this can not be null. It is a single object. Parameter other is optional. To keep it empty, pass MR_PassBy_NoObject and a null pointer.

MR_std_optional_MR_Edges_AssignFromAnother()

MRC_API void MR_std_optional_MR_Edges_AssignFromAnother	(	MR_std_optional_MR_Edges *	_this,
		MR_PassBy	other_pass_by,
		MR_std_optional_MR_Edges *	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. The reference to the parameter other might be preserved in this object. When this function is called, this object will drop any object references it had previously.

MR_std_optional_MR_Edges_ConstructFrom()

MRC_API MR_std_optional_MR_Edges * MR_std_optional_MR_Edges_ConstructFrom	(	MR_PassBy	other_pass_by,
		MR_Edges *	other )

Constructs a new instance. Parameter other is optional. To keep it empty, pass MR_PassBy_NoObject and a null pointer. Never returns null. Returns an instance allocated on the heap! Must call MR_std_optional_MR_Edges_Destroy() to free it when you're done using it.

MR_std_optional_MR_Edges_ConstructFromAnother()

MRC_API MR_std_optional_MR_Edges * MR_std_optional_MR_Edges_ConstructFromAnother	(	MR_PassBy	other_pass_by,
		MR_std_optional_MR_Edges *	other )

Constructs a copy of another instance. The source remains alive. The reference to the parameter other might be preserved in the constructed object. Never returns null. Returns an instance allocated on the heap! Must call MR_std_optional_MR_Edges_Destroy() to free it when you're done using it. When this function is called, this object will drop any object references it had previously.

MR_std_optional_MR_Edges_DefaultConstruct()

MRC_API MR_std_optional_MR_Edges * MR_std_optional_MR_Edges_DefaultConstruct

(

void

)

Constructs an empty (default-constructed) instance. Never returns null. Returns an instance allocated on the heap! Must call MR_std_optional_MR_Edges_Destroy() to free it when you're done using it.

MR_std_optional_MR_Edges_DefaultConstructArray()

MRC_API MR_std_optional_MR_Edges * MR_std_optional_MR_Edges_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_optional_MR_Edges_DestroyArray(). Use MR_std_optional_MR_Edges_OffsetMutablePtr() and MR_std_optional_MR_Edges_OffsetPtr() to access the array elements.

MR_std_optional_MR_Edges_Destroy()

MRC_API void MR_std_optional_MR_Edges_Destroy

(

const MR_std_optional_MR_Edges *

_this

)

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

MR_std_optional_MR_Edges_DestroyArray()

MRC_API void MR_std_optional_MR_Edges_DestroyArray

(

const MR_std_optional_MR_Edges *

_this

)

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

MR_std_optional_MR_Edges_MutableValue()

MRC_API MR_Edges * MR_std_optional_MR_Edges_MutableValue

(

MR_std_optional_MR_Edges *

_this

)

The stored element or null if none, mutable. Parameter _this can not be null. It is a single object.

MR_std_optional_MR_Edges_OffsetMutablePtr()

MRC_API MR_std_optional_MR_Edges * MR_std_optional_MR_Edges_OffsetMutablePtr	(	MR_std_optional_MR_Edges *	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_std_optional_MR_Edges_OffsetPtr()

MRC_API const MR_std_optional_MR_Edges * MR_std_optional_MR_Edges_OffsetPtr	(	const MR_std_optional_MR_Edges *	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_std_optional_MR_Edges_Value()

MRC_API const MR_Edges * MR_std_optional_MR_Edges_Value

(

const MR_std_optional_MR_Edges *

_this

)

The stored element or null if none, read-only. Parameter _this can not be null. It is a single object.