Gjsify LogoGjsify Logo

Represents the entries in an index object.

record

Hierarchy

  • IndexEntries

Index

Constructors

Properties

name: string

Methods

  • 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().

    Parameters

    • idx: number

      the index of the entry.

    Returns Ggit.IndexEntry

  • Get a #GgitIndexEntry by index. Note that the returned #GgitIndexEntry is only valid as long as:

    1. The associated index has not 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().

    stage indicates the stage to search the file for. Stages are used in the index when merge conflicts occur, such that multiple versions of the same file can be represented in the index. Stage 0 is associated with the working tree, while stages 1 to 3 are associated with the various versions of the file in a merge conflict. The special value -1 can be used to match the first file encountered in any stage.

    Parameters

    • file: Gio.File

      the path to search.

    • stage: number

      stage to search.

    Returns Ggit.IndexEntry

  • size(): number
  • unref(): void
  • Atomically decrements the reference count of entries by one. If the reference count drops to 0, entries is freed.

    Returns void

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method