MeshLib C Docs
Loading...
Searching...
No Matches
expected_std_vector_MR_OneMeshContour_std_string.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_string MR_std_string
 
typedef struct MR_std_vector_MR_OneMeshContour MR_std_vector_MR_OneMeshContour
 
typedef struct MR_expected_std_vector_MR_OneMeshContour_std_string MR_expected_std_vector_MR_OneMeshContour_std_string
 

Functions

MRC_API MR_expected_std_vector_MR_OneMeshContour_std_stringMR_expected_std_vector_MR_OneMeshContour_std_string_DefaultConstruct (void)
 
MRC_API MR_expected_std_vector_MR_OneMeshContour_std_stringMR_expected_std_vector_MR_OneMeshContour_std_string_DefaultConstructArray (size_t num_elems)
 
MRC_API MR_expected_std_vector_MR_OneMeshContour_std_stringMR_expected_std_vector_MR_OneMeshContour_std_string_ConstructFromAnother (MR_PassBy other_pass_by, MR_expected_std_vector_MR_OneMeshContour_std_string *other)
 
MRC_API void MR_expected_std_vector_MR_OneMeshContour_std_string_AssignFromAnother (MR_expected_std_vector_MR_OneMeshContour_std_string *_this, MR_PassBy other_pass_by, MR_expected_std_vector_MR_OneMeshContour_std_string *other)
 
MRC_API void MR_expected_std_vector_MR_OneMeshContour_std_string_Destroy (const MR_expected_std_vector_MR_OneMeshContour_std_string *_this)
 Destroys a heap-allocated instance of MR_expected_std_vector_MR_OneMeshContour_std_string. Does nothing if the pointer is null.
 
MRC_API void MR_expected_std_vector_MR_OneMeshContour_std_string_DestroyArray (const MR_expected_std_vector_MR_OneMeshContour_std_string *_this)
 Destroys a heap-allocated array of MR_expected_std_vector_MR_OneMeshContour_std_string. Does nothing if the pointer is null.
 
MRC_API const MR_expected_std_vector_MR_OneMeshContour_std_stringMR_expected_std_vector_MR_OneMeshContour_std_string_OffsetPtr (const MR_expected_std_vector_MR_OneMeshContour_std_string *ptr, ptrdiff_t i)
 
MRC_API MR_expected_std_vector_MR_OneMeshContour_std_stringMR_expected_std_vector_MR_OneMeshContour_std_string_OffsetMutablePtr (MR_expected_std_vector_MR_OneMeshContour_std_string *ptr, ptrdiff_t i)
 
MRC_API bool MR_expected_std_vector_MR_OneMeshContour_std_string_Success (const MR_expected_std_vector_MR_OneMeshContour_std_string *_this)
 
MRC_API const MR_std_vector_MR_OneMeshContourMR_expected_std_vector_MR_OneMeshContour_std_string_GetValue (const MR_expected_std_vector_MR_OneMeshContour_std_string *_this)
 
MRC_API const MR_std_stringMR_expected_std_vector_MR_OneMeshContour_std_string_GetError (const MR_expected_std_vector_MR_OneMeshContour_std_string *_this)
 
MRC_API MR_std_vector_MR_OneMeshContourMR_expected_std_vector_MR_OneMeshContour_std_string_GetMutableValue (MR_expected_std_vector_MR_OneMeshContour_std_string *_this)
 
MRC_API MR_std_stringMR_expected_std_vector_MR_OneMeshContour_std_string_GetMutableError (MR_expected_std_vector_MR_OneMeshContour_std_string *_this)
 

Typedef Documentation

◆ MR_expected_std_vector_MR_OneMeshContour_std_string

Stores either a std::vector<MR::OneMeshContour> that represents success or a std::string 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_string

typedef struct MR_std_string MR_std_string

◆ MR_std_vector_MR_OneMeshContour

Function Documentation

◆ MR_expected_std_vector_MR_OneMeshContour_std_string_AssignFromAnother()

MRC_API void MR_expected_std_vector_MR_OneMeshContour_std_string_AssignFromAnother ( MR_expected_std_vector_MR_OneMeshContour_std_string * _this,
MR_PassBy other_pass_by,
MR_expected_std_vector_MR_OneMeshContour_std_string * 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_expected_std_vector_MR_OneMeshContour_std_string_ConstructFromAnother()

MRC_API MR_expected_std_vector_MR_OneMeshContour_std_string * MR_expected_std_vector_MR_OneMeshContour_std_string_ConstructFromAnother ( MR_PassBy other_pass_by,
MR_expected_std_vector_MR_OneMeshContour_std_string * 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_expected_std_vector_MR_OneMeshContour_std_string_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_expected_std_vector_MR_OneMeshContour_std_string_DefaultConstruct()

MRC_API MR_expected_std_vector_MR_OneMeshContour_std_string * MR_expected_std_vector_MR_OneMeshContour_std_string_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_OneMeshContour_std_string_Destroy() to free it when you're done using it.

◆ MR_expected_std_vector_MR_OneMeshContour_std_string_DefaultConstructArray()

MRC_API MR_expected_std_vector_MR_OneMeshContour_std_string * MR_expected_std_vector_MR_OneMeshContour_std_string_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_OneMeshContour_std_string_DestroyArray(). Use MR_expected_std_vector_MR_OneMeshContour_std_string_OffsetMutablePtr() and MR_expected_std_vector_MR_OneMeshContour_std_string_OffsetPtr() to access the array elements.

◆ MR_expected_std_vector_MR_OneMeshContour_std_string_Destroy()

MRC_API void MR_expected_std_vector_MR_OneMeshContour_std_string_Destroy ( const MR_expected_std_vector_MR_OneMeshContour_std_string * _this)

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

◆ MR_expected_std_vector_MR_OneMeshContour_std_string_DestroyArray()

MRC_API void MR_expected_std_vector_MR_OneMeshContour_std_string_DestroyArray ( const MR_expected_std_vector_MR_OneMeshContour_std_string * _this)

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

◆ MR_expected_std_vector_MR_OneMeshContour_std_string_GetError()

MRC_API const MR_std_string * MR_expected_std_vector_MR_OneMeshContour_std_string_GetError ( const MR_expected_std_vector_MR_OneMeshContour_std_string * _this)

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

◆ MR_expected_std_vector_MR_OneMeshContour_std_string_GetMutableError()

MRC_API MR_std_string * MR_expected_std_vector_MR_OneMeshContour_std_string_GetMutableError ( MR_expected_std_vector_MR_OneMeshContour_std_string * _this)

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

◆ MR_expected_std_vector_MR_OneMeshContour_std_string_GetMutableValue()

MRC_API MR_std_vector_MR_OneMeshContour * MR_expected_std_vector_MR_OneMeshContour_std_string_GetMutableValue ( MR_expected_std_vector_MR_OneMeshContour_std_string * _this)

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

◆ MR_expected_std_vector_MR_OneMeshContour_std_string_GetValue()

MRC_API const MR_std_vector_MR_OneMeshContour * MR_expected_std_vector_MR_OneMeshContour_std_string_GetValue ( const MR_expected_std_vector_MR_OneMeshContour_std_string * _this)

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

◆ MR_expected_std_vector_MR_OneMeshContour_std_string_OffsetMutablePtr()

MRC_API MR_expected_std_vector_MR_OneMeshContour_std_string * MR_expected_std_vector_MR_OneMeshContour_std_string_OffsetMutablePtr ( MR_expected_std_vector_MR_OneMeshContour_std_string * 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_expected_std_vector_MR_OneMeshContour_std_string_OffsetPtr()

MRC_API const MR_expected_std_vector_MR_OneMeshContour_std_string * MR_expected_std_vector_MR_OneMeshContour_std_string_OffsetPtr ( const MR_expected_std_vector_MR_OneMeshContour_std_string * 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_expected_std_vector_MR_OneMeshContour_std_string_Success()

MRC_API bool MR_expected_std_vector_MR_OneMeshContour_std_string_Success ( const MR_expected_std_vector_MR_OneMeshContour_std_string * _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.