GI.Ggit.Objects.Index

Represents an index object.

Exported types

newtype Index

Memory-managed wrapper type.

Constructors

Index (ManagedPtr Index)

Instances

Eq Index

Defined in GI.Ggit.Objects.Index

Methods

(==) :: Index -> Index -> Bool

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

IsGValue Index

Convert Index to and from GValue with toGValue and fromGValue.

Defined in GI.Ggit.Objects.Index

Methods

toGValue :: Index -> IO GValue

fromGValue :: GValue -> IO Index

GObject Index

Defined in GI.Ggit.Objects.Index

Methods

gobjectType :: IO GType

HasParentTypes Index

Defined in GI.Ggit.Objects.Index

type ParentTypes Index

Defined in GI.Ggit.Objects.Index

type ParentTypes Index = '[Native, ObjectFactoryBase, Object, Initable]

class (GObject o, IsDescendantOf Index o) => IsIndex o

Type class for types which can be safely cast to Index, for instance with toIndex.

Instances

(GObject o, IsDescendantOf Index o) => IsIndex o

Defined in GI.Ggit.Objects.Index

toIndex :: (MonadIO m, IsIndex o) => o -> m Index

Cast to Index, for types for which this is known to be safe. For general casts, use castTo.

noIndex :: Maybe Index

A convenience alias for Nothing :: Maybe Index.

Methods

Overloaded methods

add

indexAdd

Arguments

:: (HasCallStack, MonadIO m, IsIndex a)

=> a

idx: a Index.

-> IndexEntry

entry: a IndexEntry.

-> m ()

(Can throw GError)

Add a file to the index.

addFile

indexAddFile

Arguments

:: (HasCallStack, MonadIO m, IsIndex a, IsFile b)

=> a

idx: a Index.

-> b

file: file to add.

-> m ()

(Can throw GError)

Add a file to the index. The specified file must be in the working directory and must exist and be readable.

addPath

indexAddPath

Arguments

:: (HasCallStack, MonadIO m, IsIndex a)

=> a

idx: a Index.

-> Text

path: path to the file to add.

-> m ()

(Can throw GError)

Add a file to the index by path. You can specify both relative paths (to the working directory) and absolute paths. Absolute paths however must reside in the working directory. The specified path must exist and must be readable.

getEntries

indexGetEntries

Arguments

:: (HasCallStack, MonadIO m, IsIndex a)

=> a

idx: a Index.

-> m (Maybe IndexEntries)

Returns: a IndexEntries or Nothing.

Get the index entries enumerator.

getEntriesResolveUndo

indexGetEntriesResolveUndo

Arguments

:: (HasCallStack, MonadIO m, IsIndex a)

=> a

idx: a Index.

-> m (Maybe IndexEntriesResolveUndo)

Returns: a IndexEntriesResolveUndo or Nothing.

Get the resolve undo entries enumerator.

getOwner

indexGetOwner

Arguments

:: (HasCallStack, MonadIO m, IsIndex a)

=> a

idx: a Index.

-> m (Maybe Repository)

Returns: the Repository that owns this index or Nothing.

Get the Repository that owns the index.

hasConflicts

indexHasConflicts

Arguments

:: (HasCallStack, MonadIO m, IsIndex a)

=> a

idx: a Index.

-> m Bool

Returns: True if the index has any conflicts, False otherwise.

Get whether the index has any conflicts.

open

indexOpen

Arguments

:: (HasCallStack, MonadIO m, IsFile a)

=> a

file: a File.

-> m (Maybe Index)

Returns: a Index or Nothing if an error occurred. (Can throw GError)

Create a new bare Git index object as a memory representation of the Git index file in file, without a repository to back it.

read

indexRead

Arguments

:: (HasCallStack, MonadIO m, IsIndex a)

=> a

idx: a Index.

-> Bool

force: force read even if there are in-memory changes.

-> m ()

(Can throw GError)

Update the contents of an existing index object in memory by reading from the hard disk.

If force is true, this performs a "hard" read that discards in-memory changes and always reloads the on-disk index data. If there is no on-disk version, the index will be cleared.

If force is false, this does a "soft" read that reloads the index data from disk only if it has changed since the last time it was loaded. Purely in-memory index data will be untouched. Be aware: if there are changes on disk, unwritten in-memory changes are discarded.

remove

indexRemove

Arguments

:: (HasCallStack, MonadIO m, IsIndex a, IsFile b)

=> a

idx: a Index.

-> b

file: the file to search.

-> Int32

stage: the stage to search.

-> m ()

(Can throw GError)

Remove a file from the index (specified by position).

write

indexWrite

Arguments

:: (HasCallStack, MonadIO m, IsIndex a)

=> a

idx: a Index.

-> m ()

(Can throw GError)

Write an existing index object from memory back to disk using an atomic file lock.

writeTree

indexWriteTree

Arguments

:: (HasCallStack, MonadIO m, IsIndex a)

=> a

idx: a Index.

-> m (Maybe OId)

Returns: a OId or Nothing in case of an error. (Can throw GError)

Write a new tree object to disk containing a representation of the current state of the index. The index must be associated to an existing repository and must not contain any files in conflict. You can use the resulting tree to for instance create a commit.

writeTreeTo

indexWriteTreeTo

Arguments

:: (HasCallStack, MonadIO m, IsIndex a, IsRepository b)

=> a

idx: a Index.

-> b

repository: a Repository.

-> m (Maybe OId)

Returns: a OId or Nothing in case of an error. (Can throw GError)

Write a new tree object to repository containing a representation of the current state of the index. The index must not contain any files in conflict. You can use the resulting tree to for instance create a commit.

Properties

file

No description available in the introspection data.

constructIndexFile :: (IsIndex o, IsFile a) => a -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “file” property. This is rarely needed directly, but it is used by new.

getIndexFile :: (MonadIO m, IsIndex o) => o -> m (Maybe File)

Get the value of the “file” property. When overloading is enabled, this is equivalent to

get index #file