expected_std_vector_MR_EdgePoint_MR_PathError.h File Reference

#include <MRCMesh/MRSurfacePath.h>
#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_vector_MR_EdgePoint	MR_std_vector_MR_EdgePoint
typedef struct MR_expected_std_vector_MR_EdgePoint_MR_PathError	MR_expected_std_vector_MR_EdgePoint_MR_PathError

Functions
MRC_API MR_expected_std_vector_MR_EdgePoint_MR_PathError *	MR_expected_std_vector_MR_EdgePoint_MR_PathError_DefaultConstruct (void)
MRC_API MR_expected_std_vector_MR_EdgePoint_MR_PathError *	MR_expected_std_vector_MR_EdgePoint_MR_PathError_DefaultConstructArray (size_t num_elems)
MRC_API MR_expected_std_vector_MR_EdgePoint_MR_PathError *	MR_expected_std_vector_MR_EdgePoint_MR_PathError_ConstructFromAnother (MR_PassBy other_pass_by, MR_expected_std_vector_MR_EdgePoint_MR_PathError *other)
MRC_API void	MR_expected_std_vector_MR_EdgePoint_MR_PathError_AssignFromAnother (MR_expected_std_vector_MR_EdgePoint_MR_PathError *_this, MR_PassBy other_pass_by, MR_expected_std_vector_MR_EdgePoint_MR_PathError *other)
MRC_API void	MR_expected_std_vector_MR_EdgePoint_MR_PathError_Destroy (const MR_expected_std_vector_MR_EdgePoint_MR_PathError *_this)
	Destroys a heap-allocated instance of MR_expected_std_vector_MR_EdgePoint_MR_PathError. Does nothing if the pointer is null.
MRC_API void	MR_expected_std_vector_MR_EdgePoint_MR_PathError_DestroyArray (const MR_expected_std_vector_MR_EdgePoint_MR_PathError *_this)
	Destroys a heap-allocated array of MR_expected_std_vector_MR_EdgePoint_MR_PathError. Does nothing if the pointer is null.
MRC_API const MR_expected_std_vector_MR_EdgePoint_MR_PathError *	MR_expected_std_vector_MR_EdgePoint_MR_PathError_OffsetPtr (const MR_expected_std_vector_MR_EdgePoint_MR_PathError *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_expected_std_vector_MR_EdgePoint_MR_PathError *	MR_expected_std_vector_MR_EdgePoint_MR_PathError_OffsetMutablePtr (MR_expected_std_vector_MR_EdgePoint_MR_PathError *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 bool	MR_expected_std_vector_MR_EdgePoint_MR_PathError_Success (const MR_expected_std_vector_MR_EdgePoint_MR_PathError *_this)
MRC_API const MR_std_vector_MR_EdgePoint *	MR_expected_std_vector_MR_EdgePoint_MR_PathError_GetValue (const MR_expected_std_vector_MR_EdgePoint_MR_PathError *_this)
MRC_API const MR_PathError *	MR_expected_std_vector_MR_EdgePoint_MR_PathError_GetError (const MR_expected_std_vector_MR_EdgePoint_MR_PathError *_this)
MRC_API MR_std_vector_MR_EdgePoint *	MR_expected_std_vector_MR_EdgePoint_MR_PathError_GetMutableValue (MR_expected_std_vector_MR_EdgePoint_MR_PathError *_this)
MRC_API MR_PathError *	MR_expected_std_vector_MR_EdgePoint_MR_PathError_GetMutableError (MR_expected_std_vector_MR_EdgePoint_MR_PathError *_this)

Typedef Documentation

MR_expected_std_vector_MR_EdgePoint_MR_PathError

typedef struct MR_expected_std_vector_MR_EdgePoint_MR_PathError MR_expected_std_vector_MR_EdgePoint_MR_PathError

Stores either a std::vector<MR::EdgePoint> that represents success or a MR::PathError that represents an error. 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_vector_MR_EdgePoint

typedef struct MR_std_vector_MR_EdgePoint MR_std_vector_MR_EdgePoint

Function Documentation

MR_expected_std_vector_MR_EdgePoint_MR_PathError_AssignFromAnother()

MRC_API void MR_expected_std_vector_MR_EdgePoint_MR_PathError_AssignFromAnother	(	MR_expected_std_vector_MR_EdgePoint_MR_PathError *	_this,
		MR_PassBy	other_pass_by,
		MR_expected_std_vector_MR_EdgePoint_MR_PathError *	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_expected_std_vector_MR_EdgePoint_MR_PathError_ConstructFromAnother()

MRC_API MR_expected_std_vector_MR_EdgePoint_MR_PathError * MR_expected_std_vector_MR_EdgePoint_MR_PathError_ConstructFromAnother	(	MR_PassBy	other_pass_by,
		MR_expected_std_vector_MR_EdgePoint_MR_PathError *	other )

Constructs a copy of another instance. The source remains alive. Never returns null. Returns an instance allocated on the heap! Must call MR_expected_std_vector_MR_EdgePoint_MR_PathError_Destroy() to free it when you're done using it.

MR_expected_std_vector_MR_EdgePoint_MR_PathError_DefaultConstruct()

MRC_API MR_expected_std_vector_MR_EdgePoint_MR_PathError * MR_expected_std_vector_MR_EdgePoint_MR_PathError_DefaultConstruct

(

void

)

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

MR_expected_std_vector_MR_EdgePoint_MR_PathError_DefaultConstructArray()

MRC_API MR_expected_std_vector_MR_EdgePoint_MR_PathError * MR_expected_std_vector_MR_EdgePoint_MR_PathError_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_expected_std_vector_MR_EdgePoint_MR_PathError_DestroyArray(). Use MR_expected_std_vector_MR_EdgePoint_MR_PathError_OffsetMutablePtr() and MR_expected_std_vector_MR_EdgePoint_MR_PathError_OffsetPtr() to access the array elements.

MR_expected_std_vector_MR_EdgePoint_MR_PathError_Destroy()

MRC_API void MR_expected_std_vector_MR_EdgePoint_MR_PathError_Destroy

(

const MR_expected_std_vector_MR_EdgePoint_MR_PathError *

_this

)

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

MR_expected_std_vector_MR_EdgePoint_MR_PathError_DestroyArray()

MRC_API void MR_expected_std_vector_MR_EdgePoint_MR_PathError_DestroyArray

(

const MR_expected_std_vector_MR_EdgePoint_MR_PathError *

_this

)

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

MR_expected_std_vector_MR_EdgePoint_MR_PathError_GetError()

MRC_API const MR_PathError * MR_expected_std_vector_MR_EdgePoint_MR_PathError_GetError

(

const MR_expected_std_vector_MR_EdgePoint_MR_PathError *

_this

)

If this instance represents an error, returns the stored MR::PathError. Otherwise null. Parameter _this can not be null. It is a single object.

MR_expected_std_vector_MR_EdgePoint_MR_PathError_GetMutableError()

MRC_API MR_PathError * MR_expected_std_vector_MR_EdgePoint_MR_PathError_GetMutableError

(

MR_expected_std_vector_MR_EdgePoint_MR_PathError *

_this

)

If this instance represents an error, returns the stored MR::PathError. Otherwise null. This version returns a mutable pointer. Parameter _this can not be null. It is a single object.

MR_expected_std_vector_MR_EdgePoint_MR_PathError_GetMutableValue()

MRC_API MR_std_vector_MR_EdgePoint * MR_expected_std_vector_MR_EdgePoint_MR_PathError_GetMutableValue

(

MR_expected_std_vector_MR_EdgePoint_MR_PathError *

_this

)

If this instance represents success, returns the stored std::vector<MR::EdgePoint>. Otherwise null. This version returns a mutable pointer. Parameter _this can not be null. It is a single object.

MR_expected_std_vector_MR_EdgePoint_MR_PathError_GetValue()

MRC_API const MR_std_vector_MR_EdgePoint * MR_expected_std_vector_MR_EdgePoint_MR_PathError_GetValue

(

const MR_expected_std_vector_MR_EdgePoint_MR_PathError *

_this

)

If this instance represents success, returns the stored std::vector<MR::EdgePoint>. Otherwise null. Parameter _this can not be null. It is a single object.

MR_expected_std_vector_MR_EdgePoint_MR_PathError_OffsetMutablePtr()

MRC_API MR_expected_std_vector_MR_EdgePoint_MR_PathError * MR_expected_std_vector_MR_EdgePoint_MR_PathError_OffsetMutablePtr	(	MR_expected_std_vector_MR_EdgePoint_MR_PathError *	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_expected_std_vector_MR_EdgePoint_MR_PathError_OffsetPtr()

MRC_API const MR_expected_std_vector_MR_EdgePoint_MR_PathError * MR_expected_std_vector_MR_EdgePoint_MR_PathError_OffsetPtr	(	const MR_expected_std_vector_MR_EdgePoint_MR_PathError *	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_expected_std_vector_MR_EdgePoint_MR_PathError_Success()

MRC_API bool MR_expected_std_vector_MR_EdgePoint_MR_PathError_Success

(

const MR_expected_std_vector_MR_EdgePoint_MR_PathError *

_this

)

Returns true if this instance represents success, or false if it represents an error. Parameter _this can not be null. It is a single object.