MeshLib C Docs
Loading...
Searching...
No Matches
std_vector_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.

Functions

MRC_API MR_std_vector_std_string * MR_std_vector_std_string_DefaultConstruct (void)
MRC_API MR_std_vector_std_string * MR_std_vector_std_string_DefaultConstructArray (size_t num_elems)
MRC_API MR_std_vector_std_string * MR_std_vector_std_string_ConstructFromAnother (MR_PassBy other_pass_by, MR_std_vector_std_string *other)
MRC_API void MR_std_vector_std_string_AssignFromAnother (MR_std_vector_std_string *_this, MR_PassBy other_pass_by, MR_std_vector_std_string *other)
MRC_API void MR_std_vector_std_string_Destroy (const MR_std_vector_std_string *_this)
 Destroys a heap-allocated instance of MR_std_vector_std_string. Does nothing if the pointer is null.
MRC_API void MR_std_vector_std_string_DestroyArray (const MR_std_vector_std_string *_this)
 Destroys a heap-allocated array of MR_std_vector_std_string. Does nothing if the pointer is null.
MRC_API const MR_std_vector_std_string * MR_std_vector_std_string_OffsetPtr (const MR_std_vector_std_string *ptr, ptrdiff_t i)
MRC_API MR_std_vector_std_string * MR_std_vector_std_string_OffsetMutablePtr (MR_std_vector_std_string *ptr, ptrdiff_t i)
MRC_API size_t MR_std_vector_std_string_size (const MR_std_vector_std_string *_this)
MRC_API bool MR_std_vector_std_string_empty (const MR_std_vector_std_string *_this)
MRC_API void MR_std_vector_std_string_resize (MR_std_vector_std_string *_this, size_t new_size)
MRC_API void MR_std_vector_std_string_clear (MR_std_vector_std_string *_this)
MRC_API void MR_std_vector_std_string_reserve (MR_std_vector_std_string *_this, size_t new_capacity)
MRC_API const MR_std_string * MR_std_vector_std_string_at (const MR_std_vector_std_string *_this, size_t i)
MRC_API MR_std_string * MR_std_vector_std_string_at_mut (MR_std_vector_std_string *_this, size_t i)
MRC_API const MR_std_string * MR_std_vector_std_string_front (const MR_std_vector_std_string *_this)
MRC_API MR_std_string * MR_std_vector_std_string_front_mut (MR_std_vector_std_string *_this)
MRC_API const MR_std_string * MR_std_vector_std_string_back (const MR_std_vector_std_string *_this)
MRC_API MR_std_string * MR_std_vector_std_string_back_mut (MR_std_vector_std_string *_this)
MRC_API void MR_std_vector_std_string_push_back (MR_std_vector_std_string *_this, const char *new_elem, const char *new_elem_end)
MRC_API void MR_std_vector_std_string_pop_back (MR_std_vector_std_string *_this)
MRC_API void MR_std_vector_std_string_insert (MR_std_vector_std_string *_this, size_t position, const char *new_elem, const char *new_elem_end)
MRC_API void MR_std_vector_std_string_erase (MR_std_vector_std_string *_this, size_t position)

Function Documentation

◆ MR_std_vector_std_string_AssignFromAnother()

MRC_API void MR_std_vector_std_string_AssignFromAnother ( MR_std_vector_std_string * _this,
MR_PassBy other_pass_by,
MR_std_vector_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 held previously.

◆ MR_std_vector_std_string_at()

MRC_API const MR_std_string * MR_std_vector_std_string_at ( const MR_std_vector_std_string * _this,
size_t i )

The element at a specific index, read-only. Parameter _this can not be null. It is a single object. The returned pointer will never be null. It is non-owning, do NOT destroy it. The reference to this object might be preserved as the return value.

◆ MR_std_vector_std_string_at_mut()

MRC_API MR_std_string * MR_std_vector_std_string_at_mut ( MR_std_vector_std_string * _this,
size_t i )

The element at a specific index, mutable. Parameter _this can not be null. It is a single object. The returned pointer will never be null. It is non-owning, do NOT destroy it. The reference to this object might be preserved as the return value.

◆ MR_std_vector_std_string_back()

MRC_API const MR_std_string * MR_std_vector_std_string_back ( const MR_std_vector_std_string * _this)

The last element or null if empty, 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_vector_std_string_back_mut()

MRC_API MR_std_string * MR_std_vector_std_string_back_mut ( MR_std_vector_std_string * _this)

The last element or null if empty, mutable. 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_vector_std_string_clear()

MRC_API void MR_std_vector_std_string_clear ( MR_std_vector_std_string * _this)

Removes all elements from the container. Parameter _this can not be null. It is a single object. When this function is called, this object will drop any object references it held previously.

◆ MR_std_vector_std_string_ConstructFromAnother()

MRC_API MR_std_vector_std_string * MR_std_vector_std_string_ConstructFromAnother ( MR_PassBy other_pass_by,
MR_std_vector_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_std_vector_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 held previously.

◆ MR_std_vector_std_string_DefaultConstruct()

MRC_API MR_std_vector_std_string * MR_std_vector_std_string_DefaultConstruct ( void )

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

◆ MR_std_vector_std_string_DefaultConstructArray()

MRC_API MR_std_vector_std_string * MR_std_vector_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_std_vector_std_string_DestroyArray(). Use MR_std_vector_std_string_OffsetMutablePtr() and MR_std_vector_std_string_OffsetPtr() to access the array elements.

◆ MR_std_vector_std_string_Destroy()

MRC_API void MR_std_vector_std_string_Destroy ( const MR_std_vector_std_string * _this)

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

◆ MR_std_vector_std_string_DestroyArray()

MRC_API void MR_std_vector_std_string_DestroyArray ( const MR_std_vector_std_string * _this)

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

◆ MR_std_vector_std_string_empty()

MRC_API bool MR_std_vector_std_string_empty ( const MR_std_vector_std_string * _this)

Returns true if the size is zero. Parameter _this can not be null. It is a single object.

◆ MR_std_vector_std_string_erase()

MRC_API void MR_std_vector_std_string_erase ( MR_std_vector_std_string * _this,
size_t position )

Erases the element at the specified position. Parameter _this can not be null. It is a single object.

◆ MR_std_vector_std_string_front()

MRC_API const MR_std_string * MR_std_vector_std_string_front ( const MR_std_vector_std_string * _this)

The first element or null if empty, 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_vector_std_string_front_mut()

MRC_API MR_std_string * MR_std_vector_std_string_front_mut ( MR_std_vector_std_string * _this)

The first element or null if empty, mutable. 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_vector_std_string_insert()

MRC_API void MR_std_vector_std_string_insert ( MR_std_vector_std_string * _this,
size_t position,
const char * new_elem,
const char * new_elem_end )

Inserts a new element right before the specified position. Parameter _this can not be null. It is a single object. Parameter new_elem can not be null. If new_elem_end is null, then new_elem is assumed to be null-terminated. The reference to the parameter new_elem might be preserved in this object.

◆ MR_std_vector_std_string_OffsetMutablePtr()

MRC_API MR_std_vector_std_string * MR_std_vector_std_string_OffsetMutablePtr ( MR_std_vector_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_std_vector_std_string_OffsetPtr()

MRC_API const MR_std_vector_std_string * MR_std_vector_std_string_OffsetPtr ( const MR_std_vector_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_std_vector_std_string_pop_back()

MRC_API void MR_std_vector_std_string_pop_back ( MR_std_vector_std_string * _this)

Removes one element from the end. Parameter _this can not be null. It is a single object.

◆ MR_std_vector_std_string_push_back()

MRC_API void MR_std_vector_std_string_push_back ( MR_std_vector_std_string * _this,
const char * new_elem,
const char * new_elem_end )

Inserts a new element at the end. Parameter _this can not be null. It is a single object. Parameter new_elem can not be null. If new_elem_end is null, then new_elem is assumed to be null-terminated. The reference to the parameter new_elem might be preserved in this object.

◆ MR_std_vector_std_string_reserve()

MRC_API void MR_std_vector_std_string_reserve ( MR_std_vector_std_string * _this,
size_t new_capacity )

Reserves memory for a certain number of elements. Never shrinks the memory. Parameter _this can not be null. It is a single object.

◆ MR_std_vector_std_string_resize()

MRC_API void MR_std_vector_std_string_resize ( MR_std_vector_std_string * _this,
size_t new_size )

Resizes the container. The new elements if any are zeroed. Parameter _this can not be null. It is a single object.

◆ MR_std_vector_std_string_size()

MRC_API size_t MR_std_vector_std_string_size ( const MR_std_vector_std_string * _this)

The number of elements. Parameter _this can not be null. It is a single object.