GI.Ggit.Structs.IndexEntries

Represents the entries in an index object.

Exported types

newtype IndexEntries

Memory-managed wrapper type.

Constructors

IndexEntries (ManagedPtr IndexEntries)

Instances

Eq IndexEntries

Defined in GI.Ggit.Structs.IndexEntries

Methods

(==) :: IndexEntries -> IndexEntries -> Bool

(/=) :: IndexEntries -> IndexEntries -> Bool

GBoxed IndexEntries

Defined in GI.Ggit.Structs.IndexEntries

ManagedPtrNewtype IndexEntries

Defined in GI.Ggit.Structs.IndexEntries

Methods

toManagedPtr :: IndexEntries -> ManagedPtr IndexEntries

TypedObject IndexEntries

Defined in GI.Ggit.Structs.IndexEntries

Methods

glibType :: IO GType

HasParentTypes IndexEntries

Defined in GI.Ggit.Structs.IndexEntries

IsGValue (Maybe IndexEntries)

Convert IndexEntries to and from GValue. See toGValue and fromGValue.

Defined in GI.Ggit.Structs.IndexEntries

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe IndexEntries -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe IndexEntries)

type ParentTypes IndexEntries

Defined in GI.Ggit.Structs.IndexEntries

type ParentTypes IndexEntries = '[] :: [Type]

Methods

Click to display all available methods, including inherited ones

Methods

ref, size, unref.

Getters

getByIndex, getByPath.

Setters

None.

getByIndex

indexEntriesGetByIndex

Arguments

:: (HasCallStack, MonadIO m)

=> IndexEntries

entries: a IndexEntries.

-> Word64

idx: the index of the entry.

-> m (Maybe IndexEntry)

Returns: a IndexEntry or Nothing if out of bounds.

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

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

Changes to the IndexEntry will be reflected in the index once written back to disk using indexWrite.

getByPath

indexEntriesGetByPath

Arguments

:: (HasCallStack, MonadIO m, IsFile a)

=> IndexEntries

entries: a IndexEntries.

-> a

file: the path to search.

-> Int32

stage: stage to search.

-> m (Maybe IndexEntry)

Returns: a IndexEntry or Nothing if it was not found.

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

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

Changes to the IndexEntry will be reflected in the index once written back to disk using indexWrite.

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.

ref

indexEntriesRef

Arguments

:: (HasCallStack, MonadIO m)

=> IndexEntries

entries: a IndexEntries.

-> m (Maybe IndexEntries)

Returns: a IndexEntries or Nothing.

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

size

indexEntriesSize

Arguments

:: (HasCallStack, MonadIO m)

=> IndexEntries

entries: a IndexEntries.

-> m Word32

Returns: the number of entries.

Get the number of IndexEntry entries.

unref

indexEntriesUnref

Arguments

:: (HasCallStack, MonadIO m)

=> IndexEntries

entries: a IndexEntries.

-> m ()

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