std_optional_MR_IOFilter.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.

Functions
MRC_API MR_std_optional_MR_IOFilter *	MR_std_optional_MR_IOFilter_DefaultConstruct (void)
MRC_API MR_std_optional_MR_IOFilter *	MR_std_optional_MR_IOFilter_DefaultConstructArray (size_t num_elems)
MRC_API MR_std_optional_MR_IOFilter *	MR_std_optional_MR_IOFilter_ConstructFromAnother (MR_PassBy other_pass_by, MR_std_optional_MR_IOFilter *other)
MRC_API MR_std_optional_MR_IOFilter *	MR_std_optional_MR_IOFilter_ConstructFrom (MR_PassBy other_pass_by, MR_IOFilter *other)
MRC_API void	MR_std_optional_MR_IOFilter_AssignFromAnother (MR_std_optional_MR_IOFilter *_this, MR_PassBy other_pass_by, MR_std_optional_MR_IOFilter *other)
MRC_API void	MR_std_optional_MR_IOFilter_AssignFrom (MR_std_optional_MR_IOFilter *_this, MR_PassBy other_pass_by, MR_IOFilter *other)
MRC_API void	MR_std_optional_MR_IOFilter_Destroy (const MR_std_optional_MR_IOFilter *_this)
	Destroys a heap-allocated instance of MR_std_optional_MR_IOFilter. Does nothing if the pointer is null.
MRC_API void	MR_std_optional_MR_IOFilter_DestroyArray (const MR_std_optional_MR_IOFilter *_this)
	Destroys a heap-allocated array of MR_std_optional_MR_IOFilter. Does nothing if the pointer is null.
MRC_API const MR_std_optional_MR_IOFilter *	MR_std_optional_MR_IOFilter_OffsetPtr (const MR_std_optional_MR_IOFilter *ptr, ptrdiff_t i)
MRC_API MR_std_optional_MR_IOFilter *	MR_std_optional_MR_IOFilter_OffsetMutablePtr (MR_std_optional_MR_IOFilter *ptr, ptrdiff_t i)
MRC_API bool	MR_std_optional_MR_IOFilter_has_value (const MR_std_optional_MR_IOFilter *_this)
MRC_API const MR_IOFilter *	MR_std_optional_MR_IOFilter_value (const MR_std_optional_MR_IOFilter *_this)
MRC_API MR_IOFilter *	MR_std_optional_MR_IOFilter_value_mut (MR_std_optional_MR_IOFilter *_this)

Function Documentation

MR_std_optional_MR_IOFilter_AssignFrom()

MRC_API void MR_std_optional_MR_IOFilter_AssignFrom	(	MR_std_optional_MR_IOFilter *	_this,
		MR_PassBy	other_pass_by,
		MR_IOFilter *	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_IOFilter_AssignFromAnother()

MRC_API void MR_std_optional_MR_IOFilter_AssignFromAnother	(	MR_std_optional_MR_IOFilter *	_this,
		MR_PassBy	other_pass_by,
		MR_std_optional_MR_IOFilter *	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 held previously.

MR_std_optional_MR_IOFilter_ConstructFrom()

MRC_API MR_std_optional_MR_IOFilter * MR_std_optional_MR_IOFilter_ConstructFrom	(	MR_PassBy	other_pass_by,
		MR_IOFilter *	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_IOFilter_Destroy() to free it when you're done using it.

MR_std_optional_MR_IOFilter_ConstructFromAnother()

MRC_API MR_std_optional_MR_IOFilter * MR_std_optional_MR_IOFilter_ConstructFromAnother	(	MR_PassBy	other_pass_by,
		MR_std_optional_MR_IOFilter *	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_IOFilter_Destroy() to free it when you're done using it. When this function is called, this object will drop any object references it held previously.

MR_std_optional_MR_IOFilter_DefaultConstruct()

MRC_API MR_std_optional_MR_IOFilter * MR_std_optional_MR_IOFilter_DefaultConstruct

(

void

)

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

MR_std_optional_MR_IOFilter_DefaultConstructArray()

MRC_API MR_std_optional_MR_IOFilter * MR_std_optional_MR_IOFilter_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_IOFilter_DestroyArray(). Use MR_std_optional_MR_IOFilter_OffsetMutablePtr() and MR_std_optional_MR_IOFilter_OffsetPtr() to access the array elements.

MR_std_optional_MR_IOFilter_Destroy()

MRC_API void MR_std_optional_MR_IOFilter_Destroy

(

const MR_std_optional_MR_IOFilter *

_this

)

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

MR_std_optional_MR_IOFilter_DestroyArray()

MRC_API void MR_std_optional_MR_IOFilter_DestroyArray

(

const MR_std_optional_MR_IOFilter *

_this

)

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

MR_std_optional_MR_IOFilter_has_value()

MRC_API bool MR_std_optional_MR_IOFilter_has_value

(

const MR_std_optional_MR_IOFilter *

_this

)

Returns true if this instance stores an object, as opposed to being empty. Parameter _this can not be null. It is a single object.

MR_std_optional_MR_IOFilter_OffsetMutablePtr()

MRC_API MR_std_optional_MR_IOFilter * MR_std_optional_MR_IOFilter_OffsetMutablePtr	(	MR_std_optional_MR_IOFilter *	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_IOFilter_OffsetPtr()

MRC_API const MR_std_optional_MR_IOFilter * MR_std_optional_MR_IOFilter_OffsetPtr	(	const MR_std_optional_MR_IOFilter *	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_IOFilter_value()

MRC_API const MR_IOFilter * MR_std_optional_MR_IOFilter_value

(

const MR_std_optional_MR_IOFilter *

_this

)

The stored element or null if none, read-only. Parameter _this can not be null. It is a single object. The reference to this object might be preserved as the return value.

MR_std_optional_MR_IOFilter_value_mut()

MRC_API MR_IOFilter * MR_std_optional_MR_IOFilter_value_mut

(

MR_std_optional_MR_IOFilter *

_this

)

The stored element or null if none, mutable. Parameter _this can not be null. It is a single object. The reference to this object might be preserved as the return value.