Modulemd.Module

Modulemd.Module — DEPRECATED: use ModulemdModuleStream instead

Functions

GQuark modulemd_module_error_quark ()
ModulemdModule * modulemd_module_new ()
ModulemdModule * modulemd_module_new_from_file ()
ModulemdModule * modulemd_module_new_from_file_ext ()
void modulemd_module_new_all_from_file ()
void modulemd_module_new_all_from_file_ext ()
ModulemdModule * modulemd_module_new_from_string ()
ModulemdModule * modulemd_module_new_from_string_ext ()
void modulemd_module_new_all_from_string ()
void modulemd_module_new_all_from_string_ext ()
ModulemdModule * modulemd_module_new_from_stream ()
ModulemdModule * modulemd_module_new_from_stream_ext ()
ModulemdModule * modulemd_module_new_from_modulestream ()
void modulemd_module_dump ()
gchar * modulemd_module_dumps ()
void modulemd_module_dump_all ()
gchar * modulemd_module_dumps_all ()
gboolean modulemd_module_upgrade ()
void modulemd_module_set_arch ()
const gchar * modulemd_module_get_arch ()
const gchar * modulemd_module_peek_arch ()
gchar * modulemd_module_dup_arch ()
void modulemd_module_set_buildopts ()
ModulemdBuildopts * modulemd_module_get_buildopts ()
ModulemdBuildopts * modulemd_module_peek_buildopts ()
void modulemd_module_set_buildrequires ()
GHashTable * modulemd_module_get_buildrequires ()
GHashTable * modulemd_module_peek_buildrequires ()
GHashTable * modulemd_module_dup_buildrequires ()
void modulemd_module_set_community ()
const gchar * modulemd_module_get_community ()
const gchar * modulemd_module_peek_community ()
gchar * modulemd_module_dup_community ()
void modulemd_module_set_content_licenses ()
ModulemdSimpleSet * modulemd_module_get_content_licenses ()
ModulemdSimpleSet * modulemd_module_peek_content_licenses ()
ModulemdSimpleSet * modulemd_module_dup_content_licenses ()
void modulemd_module_set_context ()
const gchar * modulemd_module_get_context ()
const gchar * modulemd_module_peek_context ()
gchar * modulemd_module_dup_context ()
void modulemd_module_set_dependencies ()
void modulemd_module_add_dependencies ()
GPtrArray * modulemd_module_get_dependencies ()
GPtrArray * modulemd_module_peek_dependencies ()
GPtrArray * modulemd_module_dup_dependencies ()
void modulemd_module_set_description ()
const gchar * modulemd_module_get_description ()
const gchar * modulemd_module_peek_description ()
gchar * modulemd_module_dup_description ()
void modulemd_module_set_documentation ()
const gchar * modulemd_module_get_documentation ()
const gchar * modulemd_module_peek_documentation ()
gchar * modulemd_module_dup_documentation ()
void modulemd_module_set_eol ()
const GDate * modulemd_module_get_eol ()
const GDate * modulemd_module_peek_eol ()
GDate * modulemd_module_dup_eol ()
void modulemd_module_set_mdversion ()
const guint64 modulemd_module_get_mdversion ()
guint64 modulemd_module_peek_mdversion ()
void modulemd_module_add_module_component ()
void modulemd_module_clear_module_components ()
void modulemd_module_set_module_components ()
GHashTable * modulemd_module_get_module_components ()
GHashTable * modulemd_module_peek_module_components ()
GHashTable * modulemd_module_dup_module_components ()
void modulemd_module_set_module_licenses ()
ModulemdSimpleSet * modulemd_module_get_module_licenses ()
ModulemdSimpleSet * modulemd_module_peek_module_licenses ()
ModulemdSimpleSet * modulemd_module_dup_module_licenses ()
void modulemd_module_set_name ()
const gchar * modulemd_module_get_name ()
const gchar * modulemd_module_peek_name ()
gchar * modulemd_module_dup_name ()
void modulemd_module_add_profile ()
void modulemd_module_clear_profiles ()
void modulemd_module_set_profiles ()
GHashTable * modulemd_module_get_profiles ()
GHashTable * modulemd_module_peek_profiles ()
GHashTable * modulemd_module_dup_profiles ()
void modulemd_module_set_requires ()
GHashTable * modulemd_module_get_requires ()
GHashTable * modulemd_module_peek_requires ()
GHashTable * modulemd_module_dup_requires ()
void modulemd_module_set_rpm_api ()
ModulemdSimpleSet * modulemd_module_get_rpm_api ()
ModulemdSimpleSet * modulemd_module_peek_rpm_api ()
ModulemdSimpleSet * modulemd_module_dup_rpm_api ()
void modulemd_module_set_rpm_artifacts ()
ModulemdSimpleSet * modulemd_module_get_rpm_artifacts ()
ModulemdSimpleSet * modulemd_module_peek_rpm_artifacts ()
ModulemdSimpleSet * modulemd_module_dup_rpm_artifacts ()
void modulemd_module_set_rpm_buildopts ()
GHashTable * modulemd_module_get_rpm_buildopts ()
GHashTable * modulemd_module_peek_rpm_buildopts ()
GHashTable * modulemd_module_dup_rpm_buildopts ()
void modulemd_module_add_rpm_component ()
void modulemd_module_clear_rpm_components ()
void modulemd_module_set_rpm_components ()
GHashTable * modulemd_module_get_rpm_components ()
GHashTable * modulemd_module_peek_rpm_components ()
GHashTable * modulemd_module_dup_rpm_components ()
void modulemd_module_set_rpm_filter ()
ModulemdSimpleSet * modulemd_module_get_rpm_filter ()
ModulemdSimpleSet * modulemd_module_peek_rpm_filter ()
ModulemdSimpleSet * modulemd_module_dup_rpm_filter ()
void modulemd_module_clear_servicelevels ()
void modulemd_module_set_servicelevels ()
void modulemd_module_add_servicelevel ()
GHashTable * modulemd_module_get_servicelevels ()
GHashTable * modulemd_module_peek_servicelevels ()
GHashTable * modulemd_module_dup_servicelevels ()
void modulemd_module_set_stream ()
const gchar * modulemd_module_get_stream ()
const gchar * modulemd_module_peek_stream ()
gchar * modulemd_module_dup_stream ()
void modulemd_module_set_summary ()
const gchar * modulemd_module_get_summary ()
const gchar * modulemd_module_peek_summary ()
gchar * modulemd_module_dup_summary ()
void modulemd_module_set_tracker ()
const gchar * modulemd_module_get_tracker ()
const gchar * modulemd_module_peek_tracker ()
gchar * modulemd_module_dup_tracker ()
void modulemd_module_set_version ()
const guint64 modulemd_module_get_version ()
guint64 modulemd_module_peek_version ()
void modulemd_module_set_xmd ()
GHashTable * modulemd_module_get_xmd ()
GHashTable * modulemd_module_peek_xmd ()
GHashTable * modulemd_module_dup_xmd ()
ModulemdModule * modulemd_module_copy ()
gchar * modulemd_module_dup_nsvc ()

Types and Values

Description

Functions

modulemd_module_error_quark ()

GQuark
modulemd_module_error_quark (void);

modulemd_module_new ()

ModulemdModule *
modulemd_module_new (void);

modulemd_module_new has been deprecated since version 1.6 and should not be used in newly-written code.

This object is being replaced by ModulemdModuleStream

Allocates a new ModulemdModule.

Returns

a new ModulemdModule.

Since: 1.0


modulemd_module_new_from_file ()

ModulemdModule *
modulemd_module_new_from_file (const gchar *yaml_file);

Allocates a new ModulemdModule from a file.

Parameters

yaml_file

A YAML file containing the module metadata. If this file contains more than one module, only the first will be loaded.

 

Returns

a new ModulemdModule. When no longer needed, free it with g_object_unref().

Since: 1.0


modulemd_module_new_from_file_ext ()

ModulemdModule *
modulemd_module_new_from_file_ext (const gchar *yaml_file,
                                   GPtrArray **failures,
                                   GError **error);

Allocates a new ModulemdModule from a file.

Parameters

yaml_file

A YAML file containing the module metadata. If this file contains more than one subdocument, only the first will be loaded (if it is a module stream document).

 

failures

An array containing any subdocuments from the YAML file that failed to parse. This must be freed with g_ptr_array_unref().

[element-type ModulemdSubdocument][transfer container][out]

Returns

a new ModulemdModule. When no longer needed, free it with g_object_unref().

Since: 1.4


modulemd_module_new_all_from_file ()

void
modulemd_module_new_all_from_file (const gchar *yaml_file,
                                   ModulemdModule ***_modules);

Allocates a list of new ModulemdModule from a file.

Parameters

yaml_file

A YAML file containing the module metadata.

 

_modules

A zero-terminated array of modules contained in this document.

[out][array zero-terminated=1][element-type ModulemdModule][transfer container]

Since: 1.0


modulemd_module_new_all_from_file_ext ()

void
modulemd_module_new_all_from_file_ext (const gchar *yaml_file,
                                       GPtrArray **data);

Allocates a GPtrArray of various supported subdocuments from a file.

Parameters

yaml_file

A YAML file containing the module metadata.

 

data

A GPtrArray of objects read from the YAML stream.

[out][array zero-terminated=1][element-type GObject][transfer container]

Since: 1.1


modulemd_module_new_from_string ()

ModulemdModule *
modulemd_module_new_from_string (const gchar *yaml_string);

Allocates a new ModulemdModule from a string.

Parameters

yaml_string

A YAML string containing the module metadata. If this string contains more than one module, only the first will be loaded.

 

Returns

a new ModulemdModule.

Since: 1.0


modulemd_module_new_from_string_ext ()

ModulemdModule *
modulemd_module_new_from_string_ext (const gchar *yaml_string,
                                     GPtrArray **failures,
                                     GError **error);

Allocates a new ModulemdModule from a string.

Parameters

yaml_string

A YAML string containing the module metadata. If this string contains more than one module, only the first will be loaded.

 

failures

An array containing any subdocuments from the YAML file that failed to parse. This must be freed with g_ptr_array_unref().

[element-type ModulemdSubdocument][transfer container][out]

Returns

a new ModulemdModule.

Since: 1.4


modulemd_module_new_all_from_string ()

void
modulemd_module_new_all_from_string (const gchar *yaml_string,
                                     ModulemdModule ***_modules);

Allocates a list of new ModulemdModule from a string.

Parameters

yaml_string

A YAML string containing the module metadata.

 

_modules

A zero-terminated array of modules contained in this document.

[out][array zero-terminated=1][element-type ModulemdModule][transfer container]

Since: 1.0


modulemd_module_new_all_from_string_ext ()

void
modulemd_module_new_all_from_string_ext
                               (const gchar *yaml_string,
                                GPtrArray **data);

Allocates a GPtrArray of various supported subdocuments from a file.

Parameters

yaml_string

A YAML string containing the module metadata.

 

data

A GPtrArray of objects read from the YAML stream.

[out][array zero-terminated=1][element-type GObject][transfer container]

Since: 1.1


modulemd_module_new_from_stream ()

ModulemdModule *
modulemd_module_new_from_stream (FILE *stream,
                                 GError **error);

Allocates a new ModulemdModule from a file.

Parameters

stream

A YAML stream containing the module metadata. If this file contains more than one module, only the first will be loaded.

 

Returns

a new ModulemdModule. When no longer needed, free it with g_object_unref().

Since: 1.4


modulemd_module_new_from_stream_ext ()

ModulemdModule *
modulemd_module_new_from_stream_ext (FILE *stream,
                                     GPtrArray **failures,
                                     GError **error);

Allocates a new ModulemdModule from a file.

Parameters

stream

A YAML stream containing the module metadata. If this file contains more than one module, only the first will be loaded.

 

failures

An array containing any subdocuments from the YAML file that failed to parse. This must be freed with g_ptr_array_unref().

[element-type ModulemdSubdocument][transfer container][out]

Returns

a new ModulemdModule. When no longer needed, free it with g_object_unref().

Since: 1.4


modulemd_module_new_from_modulestream ()

ModulemdModule *
modulemd_module_new_from_modulestream (ModulemdModuleStream *stream);

modulemd_module_dump ()

void
modulemd_module_dump (ModulemdModule *self,
                      const gchar *yaml_file);

Writes this module out to a YAML document on disk.

Parameters

yaml_file

A string containing the path to the output file

 

Since: 1.0


modulemd_module_dumps ()

gchar *
modulemd_module_dumps (ModulemdModule *self);

Writes this module out to a YAML document string.

Returns

A string containing a YAML representation of this module.

Since: 1.0


modulemd_module_dump_all ()

void
modulemd_module_dump_all (GPtrArray *module_array,
                          const gchar *yaml_file);

This function writes out a file containing one or more YAML documents generated from the supplied modules.

Parameters

module_array

A zero-terminated array of modules to be output.

[array zero-terminated=1][element-type GObject][transfer none]

Since: 1.0


modulemd_module_dumps_all ()

gchar *
modulemd_module_dumps_all (GPtrArray *module_array);

This function returns an allocated string containing one or more YAML documents generated from the supplied modules.

Parameters

module_array

A zero-terminated array of modules to be output.

[array zero-terminated=1][element-type GObject][transfer none]

Returns

A string containing a YAML representation of all provided modules.

Since: 1.0


modulemd_module_upgrade ()

gboolean
modulemd_module_upgrade (ModulemdModule *self);

This function takes content imported from earlier versions of the modulemd format and upgrades it into the most recent version.

Returns

TRUE if the upgrade was performed successfully. If this function returns FALSE, the internal state of the data is undefined and should not be used further.

Since: 1.0


modulemd_module_set_arch ()

void
modulemd_module_set_arch (ModulemdModule *self,
                          const gchar *arch);

Sets the "arch" property.

Parameters

arch

the module artifact architecture.

[nullable]

Since: 1.0


modulemd_module_get_arch ()

const gchar *
modulemd_module_get_arch (ModulemdModule *self);

Retrieves the "arch" for modulemd.

Returns

A string containing the "arch" property.

Since: 1.0


modulemd_module_peek_arch ()

const gchar *
modulemd_module_peek_arch (ModulemdModule *self);

Retrieves the "arch" for modulemd.

Returns

A string containing the "arch" property.

Since: 1.1


modulemd_module_dup_arch ()

gchar *
modulemd_module_dup_arch (ModulemdModule *self);

Retrieves a copy of the "arch" for modulemd.

Returns

A copy of the string containing the "arch" property.

Since: 1.1


modulemd_module_set_buildopts ()

void
modulemd_module_set_buildopts (ModulemdModule *self,
                               ModulemdBuildopts *buildopts);

Copies a ModulemdBuildopts object into the module. This object contains additional instructions to the build system required to build this module.

Parameters

buildopts

A ModulemdBuildopts object.

[nullable][transfer none]

Since: 1.5


modulemd_module_get_buildopts ()

ModulemdBuildopts *
modulemd_module_get_buildopts (ModulemdModule *self);

Get a copy of the ModulemdBuildopts object

Returns

a copy of the ModulemdBuildopts object. This object must be freed with g_object_unref() when the caller is finished with it. This function will return NULL if no buildopts have been set.

[transfer full]

Since: 1.5


modulemd_module_peek_buildopts ()

ModulemdBuildopts *
modulemd_module_peek_buildopts (ModulemdModule *self);

Get a copy of the ModulemdBuildopts object

[skip]

Returns

The ModulemdBuildopts object. This object must not be modified or freed. This function will return NULL if no buildopts have been set.

[transfer none]

Since: 1.6


modulemd_module_set_buildrequires ()

void
modulemd_module_set_buildrequires (ModulemdModule *self,
                                   GHashTable *buildrequires);

Sets the 'buildrequires' property. This function was deprecated and is not valid for modulemd files of version 2 or later.

Parameters

buildrequires

The requirements to build this module.

[nullable][element-type utf8 utf8]

Since: 1.0


modulemd_module_get_buildrequires ()

GHashTable *
modulemd_module_get_buildrequires (ModulemdModule *self);

Retrieves the "buildrequires" for modulemd.

Returns

A hash table containing the "buildrequires" property.

[element-type utf8 utf8][transfer none]

Since: 1.0


modulemd_module_peek_buildrequires ()

GHashTable *
modulemd_module_peek_buildrequires (ModulemdModule *self);

Retrieves the "buildrequires" for modulemd.

Returns

A hash table containing the "buildrequires" property.

[element-type utf8 utf8][transfer none]

Since: 1.1


modulemd_module_dup_buildrequires ()

GHashTable *
modulemd_module_dup_buildrequires (ModulemdModule *self);

Retrieves the "buildrequires" for modulemd.

Returns

A hash table containing the "buildrequires" property.

[element-type utf8 utf8][transfer container]

Since: 1.1


modulemd_module_set_community ()

void
modulemd_module_set_community (ModulemdModule *self,
                               const gchar *community);

Sets the "community" property.

Parameters

community

the module community.

[nullable]

Since: 1.0


modulemd_module_get_community ()

const gchar *
modulemd_module_get_community (ModulemdModule *self);

Retrieves the "community" for modulemd.

Returns

A string containing the "community" property.

Since: 1.0


modulemd_module_peek_community ()

const gchar *
modulemd_module_peek_community (ModulemdModule *self);

Retrieves the "community" for modulemd.

Returns

A string containing the "community" property.

Since: 1.1


modulemd_module_dup_community ()

gchar *
modulemd_module_dup_community (ModulemdModule *self);

Retrieves a copy of the "community" for modulemd.

Returns

A copy of string containing the "community" property.

Since: 1.1


modulemd_module_set_content_licenses ()

void
modulemd_module_set_content_licenses (ModulemdModule *self,
                                      ModulemdSimpleSet *licenses);

Sets the content_licenses property.

Parameters

licenses

A ModuleSimpleSet: The licenses under which the components of this module are released.

[nullable]

Since: 1.0


modulemd_module_get_content_licenses ()

ModulemdSimpleSet *
modulemd_module_get_content_licenses (ModulemdModule *self);

Retrieves the "content_licenses" for modulemd

Returns

a SimpleSet containing the set of licenses in the "content_licenses" property.

[transfer none]

Since: 1.0


modulemd_module_peek_content_licenses ()

ModulemdSimpleSet *
modulemd_module_peek_content_licenses (ModulemdModule *self);

Retrieves the "content_licenses" for modulemd

Returns

a SimpleSet containing the set of licenses in the "content_licenses" property.

[transfer none]

Since: 1.1


modulemd_module_dup_content_licenses ()

ModulemdSimpleSet *
modulemd_module_dup_content_licenses (ModulemdModule *self);

Retrieves the "content_licenses" for modulemd

Returns

a SimpleSet containing the set of licenses in the "content_licenses" property.

[transfer full]

Since: 1.1


modulemd_module_set_context ()

void
modulemd_module_set_context (ModulemdModule *self,
                             const gchar *context);

Sets the "context" property.

Parameters

context

the module artifact architecture.

[nullable]

Since: 1.0


modulemd_module_get_context ()

const gchar *
modulemd_module_get_context (ModulemdModule *self);

Retrieves the "context" for modulemd.

Returns

A string containing the "context" property.

Since: 1.0


modulemd_module_peek_context ()

const gchar *
modulemd_module_peek_context (ModulemdModule *self);

Retrieves the "context" for modulemd.

Returns

A string containing the "context" property.

Since: 1.1


modulemd_module_dup_context ()

gchar *
modulemd_module_dup_context (ModulemdModule *self);

Retrieves a copy of the "context" for modulemd.

Returns

A copy of the string containing the "context" property.

Since: 1.1


modulemd_module_set_dependencies ()

void
modulemd_module_set_dependencies (ModulemdModule *self,
                                  GPtrArray *deps);

Sets the list of dependency objects for this module.

Parameters

deps

The NULL-terminated list of dependencies.

[array zero-terminated=1][element-type ModulemdDependencies][transfer none][nullable]

Since: 1.0


modulemd_module_add_dependencies ()

void
modulemd_module_add_dependencies (ModulemdModule *self,
                                  ModulemdDependencies *dep);

Helper function to populate the dependencies list

Parameters

dep

A dependency object to add to this module

 

Since: 1.0


modulemd_module_get_dependencies ()

GPtrArray *
modulemd_module_get_dependencies (ModulemdModule *self);

Returns

The list of dependency objects for this module.

[element-type ModulemdDependencies][transfer none]

Since: 1.0


modulemd_module_peek_dependencies ()

GPtrArray *
modulemd_module_peek_dependencies (ModulemdModule *self);

Returns

The list of dependency objects for this module.

[element-type ModulemdDependencies][transfer none]

Since: 1.1


modulemd_module_dup_dependencies ()

GPtrArray *
modulemd_module_dup_dependencies (ModulemdModule *self);

Returns

The list of dependency objects for this module.

[element-type ModulemdDependencies][transfer container]

Since: 1.1


modulemd_module_set_description ()

void
modulemd_module_set_description (ModulemdModule *self,
                                 const gchar *description);

Sets the "description" property.

Parameters

description

the module description.

[nullable]

Since: 1.0


modulemd_module_get_description ()

const gchar *
modulemd_module_get_description (ModulemdModule *self);

Retrieves the "description" for modulemd.

Returns

A string containing the "description" property.

Since: 1.0


modulemd_module_peek_description ()

const gchar *
modulemd_module_peek_description (ModulemdModule *self);

Retrieves the "description" for modulemd.

Returns

A string containing the "description" property.

Since: 1.1


modulemd_module_dup_description ()

gchar *
modulemd_module_dup_description (ModulemdModule *self);

Retrieves a copy of the "description" for modulemd.

Returns

A copy of the string containing the "description" property.

Since: 1.1


modulemd_module_set_documentation ()

void
modulemd_module_set_documentation (ModulemdModule *self,
                                   const gchar *documentation);

Sets the "documentation" property.

Parameters

documentation

the module documentation.

[nullable]

Since: 1.0


modulemd_module_get_documentation ()

const gchar *
modulemd_module_get_documentation (ModulemdModule *self);

Retrieves the "documentation" for modulemd.

Returns

A string containing the "documentation" property.

Since: 1.0


modulemd_module_peek_documentation ()

const gchar *
modulemd_module_peek_documentation (ModulemdModule *self);

Retrieves the "documentation" for modulemd.

Returns

A string containing the "documentation" property.

Since: 1.1


modulemd_module_dup_documentation ()

gchar *
modulemd_module_dup_documentation (ModulemdModule *self);

Retrieves a copy of the "documentation" for modulemd.

Returns

A copy of the string containing the "documentation" property.

Since: 1.1


modulemd_module_set_eol ()

void
modulemd_module_set_eol (ModulemdModule *self,
                         const GDate *date);

Sets the "eol" property.

Note: This property is obsolete. Use "servicelevels" instead. This will fail on modulemd files using the version 2 or later formats.

Parameters

date

The end-of-life date of the module.

[nullable]

Since: 1.0


modulemd_module_get_eol ()

const GDate *
modulemd_module_get_eol (ModulemdModule *self);

Retrieves the "eol" property.

Note: This property is obsolete. Use "servicelevels" instead. This will fail on modulemd files using the version 2 or later formats.

Returns

A GDate containing the "EOL" date

Since: 1.0


modulemd_module_peek_eol ()

const GDate *
modulemd_module_peek_eol (ModulemdModule *self);

Retrieves the "eol" property.

Note: This property is obsolete. Use "servicelevels" instead. This will fail on modulemd files using the version 2 or later formats.

Returns

A GDate containing the "EOL" date

Since: 1.1


modulemd_module_dup_eol ()

GDate *
modulemd_module_dup_eol (ModulemdModule *self);

Retrieves a copy of the "eol" property.

Note: This property is obsolete. Use "servicelevels" instead. This will fail on modulemd files using the version 2 or later formats.

Returns

A GDate containing a copy of the "EOL" date

Since: 1.1


modulemd_module_set_mdversion ()

void
modulemd_module_set_mdversion (ModulemdModule *self,
                               const guint64 mdversion);

Sets the "mdversion" property.

Parameters

mdversion

the metadata version

 

Since: 1.0


modulemd_module_get_mdversion ()

const guint64
modulemd_module_get_mdversion (ModulemdModule *self);

Retrieves the "mdversion" for modulemd.

Returns

A 64-bit unsigned integer containing the "mdversion" property.

Since: 1.0


modulemd_module_peek_mdversion ()

guint64
modulemd_module_peek_mdversion (ModulemdModule *self);

Retrieves the "mdversion" for modulemd.

Returns

A 64-bit unsigned integer containing the "mdversion" property.


modulemd_module_add_module_component ()

void
modulemd_module_add_module_component (ModulemdModule *self,
                                      ModulemdComponentModule *component);

Adds a ModulemdComponentModule to the "module_components" hash table.

Parameters

component

A ModulemdComponentModule

 

Since: 1.0


modulemd_module_clear_module_components ()

void
modulemd_module_clear_module_components
                               (ModulemdModule *self);

Remove all entries from the "module_components" hash table.

Since: 1.0


modulemd_module_set_module_components ()

void
modulemd_module_set_module_components (ModulemdModule *self,
                                       GHashTable *components);

Sets the module_components property.

Parameters

components

The hash table of module components that comprise this module. The keys are the module name, the values are a ModulemdComponentModule containing information about that module.

[nullable][element-type utf8 ModulemdComponentModule]

Since: 1.0


modulemd_module_get_module_components ()

GHashTable *
modulemd_module_get_module_components (ModulemdModule *self);

Retrieves the "module-components" for modulemd.

Returns

A hash table containing the "module-components" property.

[element-type utf8 ModulemdComponentModule][transfer none]

Since: 1.0


modulemd_module_peek_module_components ()

GHashTable *
modulemd_module_peek_module_components
                               (ModulemdModule *self);

Retrieves the "module-components" for modulemd.

Returns

A hash table containing the "module-components" property.

[element-type utf8 ModulemdComponentModule][transfer none]

Since: 1.1


modulemd_module_dup_module_components ()

GHashTable *
modulemd_module_dup_module_components (ModulemdModule *self);

Retrieves the "module-components" for modulemd.

Returns

A copy of the hash table containing the "module-components" property.

[element-type utf8 ModulemdComponentModule][transfer container]

Since: 1.1


modulemd_module_set_module_licenses ()

void
modulemd_module_set_module_licenses (ModulemdModule *self,
                                     ModulemdSimpleSet *licenses);

Sets the module_licenses property.

Parameters

licenses

A ModuleSimpleSet: The licenses under which the components of this module are released.

[nullable]

Since: 1.0


modulemd_module_get_module_licenses ()

ModulemdSimpleSet *
modulemd_module_get_module_licenses (ModulemdModule *self);

Retrieves the "module_licenses" for modulemd

Returns

a ModulemdSimpleSet containing the set of licenses in the "module_licenses" property.

[transfer none]

Since: 1.0


modulemd_module_peek_module_licenses ()

ModulemdSimpleSet *
modulemd_module_peek_module_licenses (ModulemdModule *self);

Retrieves the "module_licenses" for modulemd

Returns

a ModulemdSimpleSet containing the set of licenses in the "module_licenses" property.

[transfer none]

Since: 1.1


modulemd_module_dup_module_licenses ()

ModulemdSimpleSet *
modulemd_module_dup_module_licenses (ModulemdModule *self);

Retrieves a copy of the "module_licenses" for modulemd

Returns

a ModulemdSimpleSet containing the set of licenses in the "module_licenses" property.

[transfer full]

Since: 1.1


modulemd_module_set_name ()

void
modulemd_module_set_name (ModulemdModule *self,
                          const gchar *name);

Sets the "name" property.

Parameters

name

the module name.

[nullable]

Since: 1.0


modulemd_module_get_name ()

const gchar *
modulemd_module_get_name (ModulemdModule *self);

Retrieves the "name" for modulemd.

Returns

A string containing the "name" property.

Since: 1.0


modulemd_module_peek_name ()

const gchar *
modulemd_module_peek_name (ModulemdModule *self);

Retrieves the "name" for modulemd.

Returns

A string containing the "name" property.

Since: 1.1


modulemd_module_dup_name ()

gchar *
modulemd_module_dup_name (ModulemdModule *self);

Retrieves a copy of the "name" for modulemd.

Returns

A copy of the string containing the "name" property.

Since: 1.1


modulemd_module_add_profile ()

void
modulemd_module_add_profile (ModulemdModule *self,
                             ModulemdProfile *profile);

Adds a ModulemdProfile definition to this module.

Parameters

profile

A ModulemdProfile

 

Since: 1.0


modulemd_module_clear_profiles ()

void
modulemd_module_clear_profiles (ModulemdModule *self);

Remove all entries from the "profiles" hash table.

Since: 1.0


modulemd_module_set_profiles ()

void
modulemd_module_set_profiles (ModulemdModule *self,
                              GHashTable *profiles);

Sets the 'profiles' property.

Parameters

profiles

The profiles avaiable for this module.

[nullable][element-type utf8 ModulemdProfile]

Since: 1.0


modulemd_module_get_profiles ()

GHashTable *
modulemd_module_get_profiles (ModulemdModule *self);

Retrieves the "profiles" for modulemd.

Returns

A hash table containing the "profiles" property.

[element-type utf8 ModulemdProfile][transfer none]

Since: 1.0


modulemd_module_peek_profiles ()

GHashTable *
modulemd_module_peek_profiles (ModulemdModule *self);

Retrieves the "profiles" for modulemd.

Returns

A hash table containing the "profiles" property.

[element-type utf8 ModulemdProfile][transfer none]

Since: 1.1


modulemd_module_dup_profiles ()

GHashTable *
modulemd_module_dup_profiles (ModulemdModule *self);

Retrieves a copy of the "profiles" for modulemd.

Returns

A hash table containing a copy of the "profiles" property.

[element-type utf8 ModulemdProfile][transfer container]

Since: 1.1


modulemd_module_set_requires ()

void
modulemd_module_set_requires (ModulemdModule *self,
                              GHashTable *requires);

Sets the 'requires' property. This function was deprecated and is not valid for modulemd files of version 2 or later.

Parameters

requires

The requirements to run this module.

[nullable][element-type utf8 utf8]

Since: 1.0


modulemd_module_get_requires ()

GHashTable *
modulemd_module_get_requires (ModulemdModule *self);

Retrieves the "requires" for modulemd.

Returns

A hash table containing the "requires" property. This function was deprecated and is not valid for modulemd files of version 2 or later.

[element-type utf8 utf8][transfer none]

Since: 1.0


modulemd_module_peek_requires ()

GHashTable *
modulemd_module_peek_requires (ModulemdModule *self);

Retrieves the "requires" for modulemd.

Returns

A hash table containing the "requires" property. This function was deprecated and is not valid for modulemd files of version 2 or later.

[element-type utf8 utf8][transfer none]

Since: 1.1


modulemd_module_dup_requires ()

GHashTable *
modulemd_module_dup_requires (ModulemdModule *self);

Retrieves a copy of the "requires" for modulemd.

Returns

A hash table containing a copy of the "buildrequires" property.

[element-type utf8 utf8][transfer container]

Since: 1.1


modulemd_module_set_rpm_api ()

void
modulemd_module_set_rpm_api (ModulemdModule *self,
                             ModulemdSimpleSet *apis);

Sets the rpm_api property.

Parameters

apis

A ModuleSimpleSet: The set of binary RPM packages that form the public API for this module.

[nullable]

Since: 1.0


modulemd_module_get_rpm_api ()

ModulemdSimpleSet *
modulemd_module_get_rpm_api (ModulemdModule *self);

Retrieves the "rpm_api" for modulemd

Returns

a SimpleSet containing the set of binary RPM packages in the "rpm_api" property.

[transfer none]

Since: 1.0


modulemd_module_peek_rpm_api ()

ModulemdSimpleSet *
modulemd_module_peek_rpm_api (ModulemdModule *self);

Retrieves the "rpm_api" for modulemd

Returns

a SimpleSet containing the set of binary RPM packages in the "rpm_api" property.

[transfer none]

Since: 1.1


modulemd_module_dup_rpm_api ()

ModulemdSimpleSet *
modulemd_module_dup_rpm_api (ModulemdModule *self);

Retrieves a copy of the "rpm_api" for modulemd

Returns

a SimpleSet containing the set of binary RPM packages in the "rpm_api" property.

[transfer full]

Since: 1.1


modulemd_module_set_rpm_artifacts ()

void
modulemd_module_set_rpm_artifacts (ModulemdModule *self,
                                   ModulemdSimpleSet *artifacts);

Sets the rpm_artifacts property.

Parameters

artifacts

A ModuleSimpleSet: The set of binary RPM packages that are contained in this module. Generally populated by the module build service.

[nullable]

Since: 1.0


modulemd_module_get_rpm_artifacts ()

ModulemdSimpleSet *
modulemd_module_get_rpm_artifacts (ModulemdModule *self);

Retrieves the "rpm_artifacts" for modulemd

Returns

a SimpleSet containing the set of binary RPMs contained in this module.

[transfer none]

Since: 1.0


modulemd_module_peek_rpm_artifacts ()

ModulemdSimpleSet *
modulemd_module_peek_rpm_artifacts (ModulemdModule *self);

Retrieves the "rpm_artifacts" for modulemd

Returns

a SimpleSet containing the set of binary RPMs contained in this module.

[transfer none]

Since: 1.1


modulemd_module_dup_rpm_artifacts ()

ModulemdSimpleSet *
modulemd_module_dup_rpm_artifacts (ModulemdModule *self);

Retrieves a copy of the "rpm_artifacts" for modulemd

Returns

a SimpleSet containing the set of binary RPMs contained in this module.

[transfer full]

Since: 1.1


modulemd_module_set_rpm_buildopts ()

void
modulemd_module_set_rpm_buildopts (ModulemdModule *self,
                                   GHashTable *buildopts);

Sets the 'rpm-buildopts' property.

Parameters

buildopts

A dictionary of build options to pass to rpmbuild. Currently the only recognized key is "macros".

[nullable][element-type utf8 utf8]

Since: 1.0


modulemd_module_get_rpm_buildopts ()

GHashTable *
modulemd_module_get_rpm_buildopts (ModulemdModule *self);

Retrieves the "rpm-buildopts" for modulemd.

Returns

A hash table containing the "rpm-buildopts" property.

[element-type utf8 utf8][transfer none]

Since: 1.0


modulemd_module_peek_rpm_buildopts ()

GHashTable *
modulemd_module_peek_rpm_buildopts (ModulemdModule *self);

Retrieves the "rpm-buildopts" for modulemd.

Returns

A hash table containing the "rpm-buildopts" property.

[element-type utf8 utf8][transfer none]

Since: 1.1


modulemd_module_dup_rpm_buildopts ()

GHashTable *
modulemd_module_dup_rpm_buildopts (ModulemdModule *self);

Retrieves a copy of the "rpm-buildopts" for modulemd.

Returns

A hash table containing the "rpm-buildopts" property.

[element-type utf8 utf8][transfer container]

Since: 1.1


modulemd_module_add_rpm_component ()

void
modulemd_module_add_rpm_component (ModulemdModule *self,
                                   ModulemdComponentRpm *component);

Adds a ModulemdComponentRpm to the "rpm_components" hash table.

Parameters

component

A ModulemdComponentRpm

 

Since: 1.0


modulemd_module_clear_rpm_components ()

void
modulemd_module_clear_rpm_components (ModulemdModule *self);

Remove all entries from the "rpm_components" hash table.

Since: 1.0


modulemd_module_set_rpm_components ()

void
modulemd_module_set_rpm_components (ModulemdModule *self,
                                    GHashTable *components);

Sets the rpm_components property.

Parameters

components

The hash table of module components that comprise this module. The keys are the module name, the values are a ModulemdComponentRpm containing information about that module.

[nullable][element-type utf8 ModulemdComponentRpm]

Since: 1.0


modulemd_module_get_rpm_components ()

GHashTable *
modulemd_module_get_rpm_components (ModulemdModule *self);

Retrieves the "rpm-components" for modulemd.

Returns

A hash table containing the "rpm-components" property.

[element-type utf8 ModulemdComponentRpm][transfer none]

Since: 1.0


modulemd_module_peek_rpm_components ()

GHashTable *
modulemd_module_peek_rpm_components (ModulemdModule *self);

Retrieves the "rpm-components" for modulemd.

Returns

A hash table containing the "rpm-components" property.

[element-type utf8 ModulemdComponentRpm][transfer none]

Since: 1.1


modulemd_module_dup_rpm_components ()

GHashTable *
modulemd_module_dup_rpm_components (ModulemdModule *self);

Retrieves the "rpm-components" for modulemd.

Returns

A hash table containing the "rpm-components" property.

[element-type utf8 ModulemdComponentRpm][transfer container]

Since: 1.1


modulemd_module_set_rpm_filter ()

void
modulemd_module_set_rpm_filter (ModulemdModule *self,
                                ModulemdSimpleSet *filter);

Sets the rpm_artifacts property.

Parameters

filter

A ModuleSimpleSet: The set of binary RPM packages that are explicitly filtered out of this module.

[nullable]

Since: 1.0


modulemd_module_get_rpm_filter ()

ModulemdSimpleSet *
modulemd_module_get_rpm_filter (ModulemdModule *self);

Retrieves the "rpm_filter" for modulemd

Returns

a SimpleSet containing the set of binary RPMs filtered out of this module.

[transfer none]

Since: 1.0


modulemd_module_peek_rpm_filter ()

ModulemdSimpleSet *
modulemd_module_peek_rpm_filter (ModulemdModule *self);

Retrieves the "rpm_filter" for modulemd

Returns

a SimpleSet containing the set of binary RPMs filtered out of this module.

[transfer none]

Since: 1.1


modulemd_module_dup_rpm_filter ()

ModulemdSimpleSet *
modulemd_module_dup_rpm_filter (ModulemdModule *self);

Retrieves a copy of the "rpm_filter" for modulemd

Returns

a SimpleSet containing the set of binary RPMs filtered out of this module.

[transfer full]

Since: 1.1


modulemd_module_clear_servicelevels ()

void
modulemd_module_clear_servicelevels (ModulemdModule *self);

Remove all entries from the "servicelevels" hash table

Since: 1.0


modulemd_module_set_servicelevels ()

void
modulemd_module_set_servicelevels (ModulemdModule *self,
                                   GHashTable *servicelevels);

Sets the service levels for the module.

Parameters

servicelevels

A hash table of ServiceLevel objects.

[nullable][element-type utf8 ModulemdServiceLevel]

Since: 1.0


modulemd_module_add_servicelevel ()

void
modulemd_module_add_servicelevel (ModulemdModule *self,
                                  ModulemdServiceLevel *servicelevel);

Adds a service levels to the module. If the name already exists, it will be replaced by this entry and will release a reference on the previous entry.

Parameters

servicelevel

A ServiceLevel object to add to the hash table

 

Since: 1.0


modulemd_module_get_servicelevels ()

GHashTable *
modulemd_module_get_servicelevels (ModulemdModule *self);

Retrieves the service levels for the module

Returns

A hash table containing the service levels.

[element-type utf8 ModulemdServiceLevel][transfer none]

Since: 1.0


modulemd_module_peek_servicelevels ()

GHashTable *
modulemd_module_peek_servicelevels (ModulemdModule *self);

Retrieves the service levels for the module

Returns

A hash table containing the service levels.

[element-type utf8 ModulemdServiceLevel][transfer none]

Since: 1.1


modulemd_module_dup_servicelevels ()

GHashTable *
modulemd_module_dup_servicelevels (ModulemdModule *self);

Retrieves the service levels for the module

Returns

A hash table containing the service levels.

[element-type utf8 ModulemdServiceLevel][transfer container]

Since: 1.1


modulemd_module_set_stream ()

void
modulemd_module_set_stream (ModulemdModule *self,
                            const gchar *stream);

Sets the "stream" property.

Parameters

stream

the module stream.

[nullable]

Since: 1.0


modulemd_module_get_stream ()

const gchar *
modulemd_module_get_stream (ModulemdModule *self);

Retrieves the "stream" for modulemd.

Returns

A string containing the "stream" property.

Since: 1.0


modulemd_module_peek_stream ()

const gchar *
modulemd_module_peek_stream (ModulemdModule *self);

Retrieves the "stream" for modulemd.

Returns

A string containing the "stream" property.

Since: 1.1


modulemd_module_dup_stream ()

gchar *
modulemd_module_dup_stream (ModulemdModule *self);

Retrieves a copy of the "stream" for modulemd.

Returns

A copy of the string containing the "stream" property.

Since: 1.1


modulemd_module_set_summary ()

void
modulemd_module_set_summary (ModulemdModule *self,
                             const gchar *summary);

Sets the "summary" property.

Parameters

summary

the module summary.

[nullable]

Since: 1.0


modulemd_module_get_summary ()

const gchar *
modulemd_module_get_summary (ModulemdModule *self);

Retrieves the "summary" for modulemd.

Returns

A string containing the "summary" property.

Since: 1.0


modulemd_module_peek_summary ()

const gchar *
modulemd_module_peek_summary (ModulemdModule *self);

Retrieves the "summary" for modulemd.

Returns

A string containing the "summary" property.

Since: 1.1


modulemd_module_dup_summary ()

gchar *
modulemd_module_dup_summary (ModulemdModule *self);

Retrieves a copy of the "summary" for modulemd.

Returns

A copy of the string containing the "summary" property.

Since: 1.1


modulemd_module_set_tracker ()

void
modulemd_module_set_tracker (ModulemdModule *self,
                             const gchar *tracker);

Sets the "tracker" property.

Parameters

tracker

the module tracker.

[nullable]

Since: 1.0


modulemd_module_get_tracker ()

const gchar *
modulemd_module_get_tracker (ModulemdModule *self);

Retrieves the "tracker" for modulemd.

Returns

A string containing the "tracker" property.

Since: 1.0


modulemd_module_peek_tracker ()

const gchar *
modulemd_module_peek_tracker (ModulemdModule *self);

Retrieves the "tracker" for modulemd.

Returns

A string containing the "tracker" property.

Since: 1.1


modulemd_module_dup_tracker ()

gchar *
modulemd_module_dup_tracker (ModulemdModule *self);

Retrieves a copy of the "tracker" for modulemd.

Returns

A copy of the string containing the "tracker" property.

Since: 1.1


modulemd_module_set_version ()

void
modulemd_module_set_version (ModulemdModule *self,
                             const guint64 version);

Sets the "version" property.

Parameters

version

the module version

 

Since: 1.0


modulemd_module_get_version ()

const guint64
modulemd_module_get_version (ModulemdModule *self);

Retrieves the "version" for modulemd.

Returns

A 64-bit unsigned integer containing the "version" property.

Since: 1.0


modulemd_module_peek_version ()

guint64
modulemd_module_peek_version (ModulemdModule *self);

Retrieves the "version" for modulemd.

Returns

A 64-bit unsigned integer containing the "version" property.

Since: 1.1


modulemd_module_set_xmd ()

void
modulemd_module_set_xmd (ModulemdModule *self,
                         GHashTable *xmd);

Sets the 'xmd' property.

Parameters

xmd

Extensible metadata block.

[nullable][element-type utf8 GVariant]

Since: 1.0


modulemd_module_get_xmd ()

GHashTable *
modulemd_module_get_xmd (ModulemdModule *self);

Retrieves the "xmd" for modulemd.

Returns

A hash table containing the "xmd" property.

[element-type utf8 GVariant][transfer none]

Since: 1.0


modulemd_module_peek_xmd ()

GHashTable *
modulemd_module_peek_xmd (ModulemdModule *self);

Retrieves the "xmd" for modulemd.

Returns

A hash table containing the "xmd" property.

[element-type utf8 GVariant][transfer none]

Since: 1.1


modulemd_module_dup_xmd ()

GHashTable *
modulemd_module_dup_xmd (ModulemdModule *self);

Retrieves a copy of the "xmd" for modulemd.

Returns

A hash table containing the "xmd" property.

[element-type utf8 GVariant][transfer container]

Since: 1.1


modulemd_module_copy ()

ModulemdModule *
modulemd_module_copy (ModulemdModule *self);

Make a copy of the current module

Returns

A deep copy of this ModulemdModule.

[transfer full]

Since: 1.1


modulemd_module_dup_nsvc ()

gchar *
modulemd_module_dup_nsvc (ModulemdModule *self);

Return the unique module identifier.

Returns

a string describing the unique module identifier in the form: "NAME:STREAM:VERSION[:CONTEXT]". This string is owned by the caller and must be freed with g_free().

Types and Values

MODULEMD_MODULE_ERROR

#define MODULEMD_MODULE_ERROR modulemd_module_error_quark ()

MODULEMD_TYPE_MODULE

#define MODULEMD_TYPE_MODULE modulemd_module_get_type ()

ModulemdModule

typedef struct _ModulemdModule ModulemdModule;