Top | ![]() |
![]() |
![]() |
![]() |
Modulemd.ModuleStream (Private)Modulemd.ModuleStream (Private) — ModulemdModuleStream methods that should only be used by internal consumers. |
void modulemd_module_stream_set_module_name (ModulemdModuleStream *self
,const gchar *module_name
);
self |
This ModulemdModuleStream object. |
[in] |
module_name |
The module name this object represents. |
Since: 2.0
void modulemd_module_stream_set_stream_name (ModulemdModuleStream *self
,const gchar *stream_name
);
self |
This ModulemdModuleStream object. |
[in] |
stream_name |
The stream name this object represents. |
Since: 2.0
void modulemd_module_stream_associate_translation (ModulemdModuleStream *self
,ModulemdTranslation *translation
);
self |
This ModulemdModuleStream object. |
[in] |
translation |
The ModulemdTranslation information to associate with this object. |
[in] |
Since: 2.0
ModulemdTranslation *
modulemd_module_stream_get_translation
(ModulemdModuleStream *self
);
Since: 2.0
ModulemdTranslationEntry * modulemd_module_stream_get_translation_entry (ModulemdModuleStream *self
,const gchar *locale
);
self |
This ModulemdModuleStream object. |
[in] |
locale |
The locale of the translation to retrieve. |
The module stream ModulemdTranslationEntry for the requested locale, or NULL if the locale was unknown.
[transfer none]
Since: 2.0
gboolean modulemd_module_stream_validate_components (GHashTable *components
,GError **error
);
Verifies that each of the ModulemdComponent objects in components
validates correctly via modulemd_component_validate()
, verifies that any
buildafter components are also present in components
, and verifies that
buildorder and buildafter aren't mixed.
components |
A GHashTable of ModulemdComponent objects. |
[in] |
error |
A GError that will return the reason for a validation error. |
[out] |
TRUE if the component objects passed validation. FALSE and sets
error
appropriately if validation fails.
Since: 2.0
#define STREAM_UPGRADE_IF_SET_FULL( \ oldversion, newversion, dest, src, property, locale...)
DIRECT USE OF THIS MACRO SHOULD BE AVOIDED. This is the internal
implementation for STREAM_COPY_IF_SET
, STREAM_UPGRADE_IF_SET
,
STREAM_COPY_IF_SET_WITH_LOCALE
, and STREAM_UPGRADE_IF_SET_WITH_LOCALE
which should be used instead.
This is a helper macro to simplify the coding when copying/upgrading properties between ModulemdModuleStreamV1 and ModulemdModuleStreamV2 objects.
Does nothing if the src
property
is NULL.
oldversion |
The stream version of |
|
newversion |
The stream version of |
|
dest |
A ModulemdModuleStreamV1 or ModulemdModuleStreamV2 object
that is the destination to which |
[out] |
src |
A ModulemdModuleStreamV1 or ModulemdModuleStreamV2 object that
is the source from which |
[in] |
property |
The name of the property to copy. Must be the literal property name, in lower case, without quotes. |
|
locale... |
An optional locale that can be provided when |
[in] |
Since: 2.0
#define STREAM_COPY_IF_SET(version, dest, src, property)
This is a convenience macro to simplify the coding when copying properties
between ModulemdModuleStream objects when both src
and dest
are the same
version.
Does nothing if the src
property
is NULL.
version |
The stream version being copied. Must be literal "v1" or "v2" without the quotes. |
|
dest |
A ModulemdModuleStreamV1 or ModulemdModuleStreamV2 object
that is the destination to which |
[out] |
src |
A ModulemdModuleStreamV1 or ModulemdModuleStreamV2 object that
is the source from which |
[in] |
property |
The name of the property to copy. Must be the literal property name, in lower case, without quotes. |
Since: 2.0
#define STREAM_UPGRADE_IF_SET(oldversion, newversion, dest, src, property)
This is a convenience macro to simplify the coding when copying properties
between ModulemdModuleStreamV1 and ModulemdModuleStreamV2 objects when
src
and dest
are different versions.
Does nothing if the src
property
is NULL.
oldversion |
The stream version of |
|
newversion |
The stream version of |
|
dest |
A ModulemdModuleStreamV1 or ModulemdModuleStreamV2 object
that is the destination to which |
[out] |
src |
A ModulemdModuleStreamV1 or ModulemdModuleStreamV2 object that
is the source from which |
[in] |
property |
The name of the property to copy. Must be the literal property name, in lower case, without quotes. |
Since: 2.0
#define STREAM_COPY_IF_SET_WITH_LOCALE(version, dest, src, property)
This is a convenience macro to simplify the coding when copying properties
between ModulemdModuleStreamV1 and ModulemdModuleStreamV2 objects when
both src
and dest
are the same version and property
has possible
translations. Only the untranslated ("C"
locale) version of property
will
be copied.
Does nothing if the src
property
is NULL.
version |
The stream version being copied. Must be literal "v1" or "v2" without the quotes. |
|
dest |
A ModulemdModuleStreamV1 or ModulemdModuleStreamV2 object
that is the destination to which |
[out] |
src |
A ModulemdModuleStreamV1 or ModulemdModuleStreamV2 object that
is the source from which |
[in] |
property |
The name of the property to copy. Must be the literal property name, in lower case, without quotes. |
Since: 2.0
#define STREAM_UPGRADE_IF_SET_WITH_LOCALE( \ oldversion, newversion, dest, src, property)
This is a convenience macro to simply the coding when copying properties
between ModulemdModuleStreamV1 and ModulemdModuleStreamV2 objects when
src
and dest
are different versions and property
has possible
translations. Only the untranslated ("C"
locale) version of property
will
be copied.
Does nothing if the src
property
is NULL.
oldversion |
The stream version of |
|
newversion |
The stream version of |
|
dest |
A ModulemdModuleStreamV1 or ModulemdModuleStreamV2 object
that is the destination to which |
[out] |
src |
A ModulemdModuleStreamV1 or ModulemdModuleStreamV2 object that
is the source from which |
[in] |
property |
The name of the property to copy. Must be the literal property name, in lower case, without quotes. |
Since: 2.0
#define STREAM_REPLACE_HASHTABLE(version, dest, src, property)
This is a convenience macro to simply the coding when replacing GHashTable
properties of ModulemdModuleStreamV1 and ModulemdModuleStreamV2 objects
when both src
and dest
are the same version.
version |
The stream version being replaced. Must be literal "v1" or "v2" without the quotes. |
|
dest |
A ModulemdModuleStreamV1 or ModulemdModuleStreamV2 object
that is the destination at which |
[out] |
src |
A ModulemdModuleStreamV1 or ModulemdModuleStreamV2 object that
is the source from which |
[in] |
property |
The name of the GHashTable property to replace. Must be the literal property name, in lower case, without quotes. |
Since: 2.0
#define COPY_HASHTABLE_BY_VALUE_ADDER(dest, src, property, adder)
This is a convenience macro to simply the coding when copying GHashTable properties between ModulemdModuleStreamV1 and ModulemdModuleStreamV2 objects when the property is set by using add-on values.
dest |
A ModulemdModuleStreamV1 or ModulemdModuleStreamV2 object
that is the destination to which |
[out] |
src |
A ModulemdModuleStreamV1 or ModulemdModuleStreamV2 object that
is the source from which |
[in] |
property |
The name of the GHashTable property to copy. Must be the literal property name, in lower case, without quotes. |
|
adder |
A pointer to a method of |
[in] |
Since: 2.0
gboolean modulemd_module_stream_emit_yaml_base (ModulemdModuleStream *self
,yaml_emitter_t *emitter
,GError **error
);
Emit the common non-version specific YAML components for the Module Stream document.
self |
This ModulemdModuleStream object. |
|
emitter |
A libyaml emitter object positioned where a Module Stream document belongs in the YAML document. |
[inout] |
error |
A GError that will return the reason for an emission or validation error. |
[out] |
TRUE if the ModulemdModuleStream components were emitted
successfully. FALSE and sets error
appropriately if the YAML could not be
emitted.
Since: 2.0