GanId

GanId —

Synopsis




            GanId;
GanId*      gan_id_new                      ();
void        gan_id_unref                    (GanId *id);
GanId*      gan_id_generate                 ();
GanId*      gan_id_new_with_id              (uuid_t uuid);
GanId*      gan_id_dup                      (const GanId *id);
void        gan_id_assign                   (GanId *id,
                                             const GanId *other);
void        gan_id_clear                    (GanId *id);
void        gan_id_set_id                   (GanId *id,
                                             uuid_t uuid);
void        gan_id_get_id                   (const GanId *id,
                                             uuid_t uuid);
gboolean    gan_id_is_null                  (const GanId *id);
gboolean    gan_id_equals                   (const GanId *this,
                                             const GanId *that);
gboolean    gan_id_in_list                  (const GanId *id,
                                             const GList *list);
gchar*      gan_id_get_description          (const GanId *id);

Description

Details

GanId

typedef struct {
  GObject parent;
  uuid_t uuid;
} GanId;

gan_id_new ()

GanId*      gan_id_new                      ();

Generate a new, NULL identifier.

Returns : A new identifier.

gan_id_unref ()

void        gan_id_unref                    (GanId *id);

Decrement the GObject reference counter for an identifier.

id :

gan_id_generate ()

GanId*      gan_id_generate                 ();

Generate a new, world-unique identifier.

Returns : A new identifier.

gan_id_new_with_id ()

GanId*      gan_id_new_with_id              (uuid_t uuid);

Create a new identifier with a uuid_t.

uuid : The uuid_t to assign the new identifier.
Returns : A new identifier.

gan_id_dup ()

GanId*      gan_id_dup                      (const GanId *id);

Duplicate an identifier.

id : The identifier to duplicate.
Returns : A copy of id.

gan_id_assign ()

void        gan_id_assign                   (GanId *id,
                                             const GanId *other);

Assign the value one identifier to another.

id : The identifier to be assigned to.
other : The identifier whose value to assign.

gan_id_clear ()

void        gan_id_clear                    (GanId *id);

Set an itentifier to NULL.

id : The identifier to nullify.

gan_id_set_id ()

void        gan_id_set_id                   (GanId *id,
                                             uuid_t uuid);

Set an identifier to the value of a uuid_t.

id : The identifier whose value to set.
uuid : The uuid_t to set it to.

gan_id_get_id ()

void        gan_id_get_id                   (const GanId *id,
                                             uuid_t uuid);

Extract the value of an identifier into a uuid_t.

id : The identifier whose value to extract.
uuid : The uuid_t to extract the value into.

gan_id_is_null ()

gboolean    gan_id_is_null                  (const GanId *id);

Determine whether an identifier is NULL.

id : The identifier to check.
Returns : TRUE if the value is NULL, or FALSE if it isn't.

gan_id_equals ()

gboolean    gan_id_equals                   (const GanId *this,
                                             const GanId *that);

Check two identifiers for equality.

this : The identifier to check for equality.
that : The identifier to check against.
Returns : TRUE if the two identifiers are equal, FALSE if they are unequal.

gan_id_in_list ()

gboolean    gan_id_in_list                  (const GanId *id,
                                             const GList *list);

Check whether a list of identifiers contains a specific identifier.

id : The identifier to search for.
list : The list of identifiers to search. The list's elements must each be a pointer to a GanId.
Returns : TRUE if list contains id, FALSE if it does not.

gan_id_get_description ()

gchar*      gan_id_get_description          (const GanId *id);

Get a string value describing an identifier. The caller must free the returned string.

id : The identifier to describe.
Returns : A string describing id.