GgitIndexEntry

GgitIndexEntry

Synopsis

                    GgitIndexEntries;
                    GgitIndexEntry;
GgitIndexEntries *  ggit_index_entries_ref              (GgitIndexEntries *entries);
void                ggit_index_entries_unref            (GgitIndexEntries *entries);
GgitIndexEntry *    ggit_index_entries_get_by_index     (GgitIndexEntries *entries,
                                                         gsize idx);
GgitIndexEntry *    ggit_index_entries_get_by_path      (GgitIndexEntries *entries,
                                                         GFile *file,
                                                         gboolean stage);
guint               ggit_index_entries_size             (GgitIndexEntries *entries);
GgitIndexEntry *    ggit_index_entry_ref                (GgitIndexEntry *entry);
void                ggit_index_entry_unref              (GgitIndexEntry *entry);
guint               ggit_index_entry_get_dev            (GgitIndexEntry *entry);
guint               ggit_index_entry_get_ino            (GgitIndexEntry *entry);
guint               ggit_index_entry_get_mode           (GgitIndexEntry *entry);
guint               ggit_index_entry_get_uid            (GgitIndexEntry *entry);
guint               ggit_index_entry_get_gid            (GgitIndexEntry *entry);
goffset             ggit_index_entry_get_file_size      (GgitIndexEntry *entry);
GgitOId *           ggit_index_entry_get_id             (GgitIndexEntry *entry);
guint               ggit_index_entry_get_flags          (GgitIndexEntry *entry);
guint               ggit_index_entry_get_flags_extended (GgitIndexEntry *entry);
GFile *             ggit_index_entry_get_file           (GgitIndexEntry *entry);

Object Hierarchy

  GBoxed
   +----GgitIndexEntries
  GBoxed
   +----GgitIndexEntry

Description

Details

GgitIndexEntries

typedef struct _GgitIndexEntries GgitIndexEntries;

Represents the entries in an index object.


GgitIndexEntry

typedef struct _GgitIndexEntry GgitIndexEntry;

Represents an index entry object.


ggit_index_entries_ref ()

GgitIndexEntries *  ggit_index_entries_ref              (GgitIndexEntries *entries);

Atomically increments the reference count of entries by one. This function is MT-safe and may be called from any thread.

entries :

a GgitIndexEntries.

Returns :

a GgitIndexEntries. [transfer none]

ggit_index_entries_unref ()

void                ggit_index_entries_unref            (GgitIndexEntries *entries);

Atomically decrements the reference count of entries by one. If the reference count drops to 0, entries is freed.

entries :

a GgitIndexEntries.

ggit_index_entries_get_by_index ()

GgitIndexEntry *    ggit_index_entries_get_by_index     (GgitIndexEntries *entries,
                                                         gsize idx);

Get a GgitIndexEntry by index. Note that the returned GgitIndexEntry is _only_ valid as long as:

1) The associated index has been closed 2) The entry has not been removed (see ggit_index_remove()) 3) The index has not been refreshed (see ggit_index_read())

Changes to the GgitIndexEntry will be reflected in the index once written back to disk using ggit_index_write().

entries :

a GgitIndexEntries.

idx :

the index of the entry.

Returns :

a GgitIndexEntry or NULL if out of bounds. [transfer full]

ggit_index_entries_get_by_path ()

GgitIndexEntry *    ggit_index_entries_get_by_path      (GgitIndexEntries *entries,
                                                         GFile *file,
                                                         gboolean stage);

Get a GgitIndexEntry by index. Note that the returned GgitIndexEntry is _only_ valid as long as:

1) The associated index has been closed 2) The entry has not been removed (see ggit_index_remove()) 3) The index has not been refreshed (see ggit_index_read())

Changes to the GgitIndexEntry will be reflected in the index once written back to disk using ggit_index_write().

entries :

a GgitIndexEntries.

file :

the path to search.

stage :

stage to search.

Returns :

a GgitIndexEntry or NULL if it was not found. [transfer full]

ggit_index_entries_size ()

guint               ggit_index_entries_size             (GgitIndexEntries *entries);

Get the number of GgitIndexEntry entries.

entries :

a GgitIndexEntries.

Returns :

the number of entries.

ggit_index_entry_ref ()

GgitIndexEntry *    ggit_index_entry_ref                (GgitIndexEntry *entry);

Atomically increments the reference count of entry by one. This function is MT-safe and may be called from any thread.

entry :

a GgitIndexEntry.

Returns :

a GgitIndexEntry. [transfer none]

ggit_index_entry_unref ()

void                ggit_index_entry_unref              (GgitIndexEntry *entry);

Atomically decrements the reference count of entry by one. If the reference count drops to 0, entry is freed.

entry :

a GgitIndexEntry.

ggit_index_entry_get_dev ()

guint               ggit_index_entry_get_dev            (GgitIndexEntry *entry);

Get the dev of the index entry.

entry :

a GgitIndexEntry.

Returns :

the dev.

ggit_index_entry_get_ino ()

guint               ggit_index_entry_get_ino            (GgitIndexEntry *entry);

Get the ino of the index entry.

entry :

a GgitIndexEntry.

Returns :

the ino.

ggit_index_entry_get_mode ()

guint               ggit_index_entry_get_mode           (GgitIndexEntry *entry);

Get the mode of the index entry.

entry :

a GgitIndexEntry.

Returns :

the mode.

ggit_index_entry_get_uid ()

guint               ggit_index_entry_get_uid            (GgitIndexEntry *entry);

Get the uid of the index entry.

entry :

a GgitIndexEntry.

Returns :

the uid.

ggit_index_entry_get_gid ()

guint               ggit_index_entry_get_gid            (GgitIndexEntry *entry);

Get the gid of the index entry.

entry :

a GgitIndexEntry.

Returns :

the gid.

ggit_index_entry_get_file_size ()

goffset             ggit_index_entry_get_file_size      (GgitIndexEntry *entry);

Get the file size of the index entry.

entry :

a GgitIndexEntry.

Returns :

the file size.

ggit_index_entry_get_id ()

GgitOId *           ggit_index_entry_get_id             (GgitIndexEntry *entry);

Get the oid of the index entry.

entry :

a GgitIndexEntry.

Returns :

the oid.

ggit_index_entry_get_flags ()

guint               ggit_index_entry_get_flags          (GgitIndexEntry *entry);

Get the flags of the index entry.

entry :

a GgitIndexEntry.

Returns :

the flags.

ggit_index_entry_get_flags_extended ()

guint               ggit_index_entry_get_flags_extended (GgitIndexEntry *entry);

Get the extended flags of the index entry.

entry :

a GgitIndexEntry.

Returns :

the extended flags.

ggit_index_entry_get_file ()

GFile *             ggit_index_entry_get_file           (GgitIndexEntry *entry);

Get the file of the index entry.

entry :

a GgitIndexEntry.

Returns :

a GFile. [transfer full]