Metadatum Label List¶

typedef struct cardano_metadatum_label_list_t cardano_metadatum_label_list_t¶

Represents a list of metadatum labels.

cardano_error_t cardano_metadatum_label_list_new(cardano_metadatum_label_list_t **metadatum_label_list)¶

Creates and initializes a new instance of a metadatum_label_list.

This function allocates and initializes a new instance of cardano_metadatum_label_list_t. It returns an error code to indicate success or failure of the operation.

Usage Example:

cardano_metadatum_label_list_t* metadatum_label_list = NULL;

// Attempt to create a new metadatum_label_list
cardano_error_t result = cardano_metadatum_label_list_new(&metadatum_label_list);

if (result == CARDANO_SUCCESS)
{
  // Use the metadatum_label_list

  // Once done, ensure to clean up and release the metadatum_label_list
  cardano_metadatum_label_list_unref(&metadatum_label_list);
}

Parameters:¶

cardano_metadatum_label_list_t **metadatum_label_list¶

[out] On successful initialization, this will point to a newly created cardano_metadatum_label_list_t object. This object represents a “strong reference” to the metadatum_label_list, meaning that it is fully initialized and ready for use. The caller is responsible for managing the lifecycle of this object. Specifically, once the metadatum_label_list is no longer needed, the caller must release it by calling cardano_metadatum_label_list_unref.

Returns:¶

CARDANO_SUCCESS if the metadatum_label_list was successfully created, or an appropriate error code indicating the failure reason.

size_t cardano_metadatum_label_list_get_length(const cardano_metadatum_label_list_t *metadatum_label_list)¶

Retrieves the length of a metadatum label list.

This function retrieves the number of elements in the provided cardano_metadatum_label_list_t object.

Usage Example:

cardano_metadatum_label_list_t* metadatum_label_list = cardano_metadatum_label_list_new();

// Populate metadatum_label_list with elements

size_t length = cardano_metadatum_label_list_get_length(metadatum_label_list);
printf("Length of the metadatum_label_list: %zu\n", length);

// Clean up the metadatum_label_list object once done
cardano_metadatum_label_list_unref(&metadatum_label_list);

Parameters:¶

const cardano_metadatum_label_list_t *metadatum_label_list¶

[in] A constant pointer to the cardano_metadatum_label_list_t object whose length is to be retrieved.

Returns:¶

The number of elements in the metadatum_label_list. Return 0 if the metadatum_label_list is NULL.

cardano_error_t cardano_metadatum_label_list_get(const cardano_metadatum_label_list_t *metadatum_label_list, size_t index, uint64_t *element)¶

Retrieves an element from a metadatum label list by index.

This function retrieves the element at the specified index from the provided cardano_metadatum_label_list_t object and stores it in the output parameter.

Usage Example:

cardano_metadatum_label_list_t* metadatum_label_list = cardano_metadatum_label_list_new();

// Populate metadatum_label_list with elements

uint64_t element = 0;
cardano_error_t result = cardano_metadatum_label_list_get(metadatum_label_list, 2, &element);

if (result == CARDANO_SUCCESS)
{
  // Use the retrieved element
}

// Clean up the metadatum_label_list object once done
cardano_metadatum_label_list_unref(&metadatum_label_list);

Parameters:¶

const cardano_metadatum_label_list_t *metadatum_label_list¶

[in] A constant pointer to the cardano_metadatum_label_list_t object from which the element is to be retrieved.

size_t index¶

[in] The index of the element to retrieve from the metadatum label list. Indexing starts at 0.

uint64_t *element¶

[out] The label as an uint64_t.

Returns:¶

CARDANO_SUCCESS if the element was successfully retrieved, or an appropriate error code indicating the failure reason.

cardano_error_t cardano_metadatum_label_list_add(cardano_metadatum_label_list_t *metadatum_label_list, uint64_t element)¶

Adds an element to a metadatum label list.

This function adds the specified element to the end of the provided cardano_metadatum_label_list_t object.

Usage Example:

cardano_metadatum_label_list_t* metadatum_label_list = cardano_metadatum_label_list_new();

// Create and initialize a new metadatum label element
uint64_t element = 755;

// Add the element to the metadatum_label_list
cardano_error_t result = cardano_metadatum_label_list_add(metadatum_label_list, element);

if (result == CARDANO_SUCCESS)
{
  // Element added successfully
}

// Clean up the metadatum_label_list object once done
cardano_metadatum_label_list_unref(&metadatum_label_list);

Parameters:¶

cardano_metadatum_label_list_t *metadatum_label_list¶

[in] A constant pointer to the cardano_metadatum_label_list_t object to which the element is to be added.

uint64_t element¶

[in] The metadatum label to be added.

Returns:¶

CARDANO_SUCCESS if the element was successfully added to the metadatum_label_list, or an appropriate error code indicating the failure reason.

void cardano_metadatum_label_list_unref(cardano_metadatum_label_list_t **metadatum_label_list)¶

Decrements the reference count of a metadatum_label_list object.

This function is responsible for managing the lifecycle of a cardano_metadatum_label_list_t object by decreasing its reference count. When the reference count reaches zero, the metadatum_label_list is finalized; its associated resources are released, and its memory is deallocated.

Usage Example:

cardano_metadatum_label_list_t* metadatum_label_list = cardano_metadatum_label_list_new();

// Perform operations with the metadatum_label_list...

cardano_metadatum_label_list_unref(&metadatum_label_list);
// At this point, metadatum_label_list is NULL and cannot be used.

Note

After calling cardano_metadatum_label_list_unref, the pointer to the cardano_metadatum_label_list_t object will be set to NULL to prevent its reuse.

Parameters:¶

cardano_metadatum_label_list_t **metadatum_label_list¶

[inout] A pointer to the pointer of the metadatum_label_list object. This double indirection allows the function to set the caller’s pointer to NULL, avoiding dangling pointer issues after the object has been freed.

void cardano_metadatum_label_list_ref(cardano_metadatum_label_list_t *metadatum_label_list)¶

Increases the reference count of the cardano_metadatum_label_list_t object.

This function is used to manually increment the reference count of a metadatum_label_list object, indicating that another part of the code has taken ownership of it. This ensures the object remains allocated and valid until all owners have released their reference by calling cardano_metadatum_label_list_unref.

Usage Example:

// Assuming metadatum_label_list is a previously created metadatum_label_list object

cardano_metadatum_label_list_ref(metadatum_label_list);

// Now metadatum_label_list can be safely used elsewhere without worrying about premature deallocation

Note

Always ensure that for every call to cardano_metadatum_label_list_ref there is a corresponding call to cardano_metadatum_label_list_unref to prevent memory leaks.

Parameters:¶

cardano_metadatum_label_list_t *metadatum_label_list¶

A pointer to the metadatum_label_list object whose reference count is to be incremented.

size_t cardano_metadatum_label_list_refcount(const cardano_metadatum_label_list_t *metadatum_label_list)¶

Retrieves the current reference count of the cardano_metadatum_label_list_t object.

This function returns the number of active references to a metadatum_label_list object. It’s useful for debugging purposes or managing the lifecycle of the object in complex scenarios.

Usage Example:

// Assuming metadatum_label_list is a previously created metadatum_label_list object

size_t ref_count = cardano_metadatum_label_list_refcount(metadatum_label_list);

printf("Reference count: %zu\n", ref_count);

Warning

This function does not account for transitive references. A transitive reference occurs when an object holds a reference to another object, rather than directly to the cardano_metadatum_label_list_t. As such, the reported count may not fully represent the total number of conceptual references in cases where such transitive relationships exist.

Parameters:¶

const cardano_metadatum_label_list_t *metadatum_label_list¶

A pointer to the metadatum_label_list object whose reference count is queried. The object must not be NULL.

Returns:¶

The number of active references to the specified metadatum_label_list object. If the object is properly managed (i.e., every cardano_metadatum_label_list_ref call is matched with a cardano_metadatum_label_list_unref call), this count should reach zero right before the object is deallocated.

void cardano_metadatum_label_list_set_last_error(cardano_metadatum_label_list_t *metadatum_label_list, const char *message)¶

Sets the last error message for a given metadatum_label_list object.

Records an error message in the metadatum_label_list’s last_error buffer, overwriting any existing message. This is useful for storing descriptive error information that can be later retrieved. The message is truncated if it exceeds the buffer’s capacity.

Note

The error message is limited to 1023 characters, including the null terminator, due to the fixed size of the last_error buffer.

Parameters:¶

cardano_metadatum_label_list_t *metadatum_label_list¶

[in] A pointer to the cardano_metadatum_label_list_t instance whose last error message is to be set. If NULL, the function does nothing.

const char *message¶

[in] A null-terminated string containing the error message. If NULL, the metadatum_label_list’s last_error is set to an empty string, indicating no error.

const char *cardano_metadatum_label_list_get_last_error(const cardano_metadatum_label_list_t *metadatum_label_list)¶

Retrieves the last error message recorded for a specific metadatum_label_list.

This function returns a pointer to the null-terminated string containing the last error message set by cardano_metadatum_label_list_set_last_error for the given metadatum_label_list. If no error message has been set, or if the last_error buffer was explicitly cleared, an empty string is returned, indicating no error.

Note

The returned string points to internal storage within the object and must not be modified by the caller. The string remains valid until the next call to cardano_metadatum_label_list_set_last_error for the same metadatum_label_list, or until the metadatum_label_list is deallocated.

Parameters:¶

const cardano_metadatum_label_list_t *metadatum_label_list¶

[in] A pointer to the cardano_metadatum_label_list_t instance whose last error message is to be retrieved. If the metadatum_label_list is NULL, the function returns a generic error message indicating the null metadatum_label_list.

Returns:¶

A pointer to a null-terminated string containing the last error message for the specified metadatum_label_list. If the metadatum_label_list is NULL, “Object is NULL.” is returned to indicate the error.