Copyright	Will Thompson Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria (inaki@blueleaf.cc)
Safe Haskell	None
Language	Haskell2010

GI.Ggit.Structs.IndexEntry

Contents

Exported types
Methods

Description

Represents an index entry object.

Synopsis

newtype IndexEntry = IndexEntry (ManagedPtr IndexEntry)
noIndexEntry :: Maybe IndexEntry
indexEntryGetDev :: (HasCallStack, MonadIO m) => IndexEntry -> m Word32
indexEntryGetFileSize :: (HasCallStack, MonadIO m) => IndexEntry -> m Int64
indexEntryGetFlags :: (HasCallStack, MonadIO m) => IndexEntry -> m Word32
indexEntryGetFlagsExtended :: (HasCallStack, MonadIO m) => IndexEntry -> m Word32
indexEntryGetGid :: (HasCallStack, MonadIO m) => IndexEntry -> m Word32
indexEntryGetId :: (HasCallStack, MonadIO m) => IndexEntry -> m (Maybe OId)
indexEntryGetIno :: (HasCallStack, MonadIO m) => IndexEntry -> m Word32
indexEntryGetMode :: (HasCallStack, MonadIO m) => IndexEntry -> m Word32
indexEntryGetPath :: (HasCallStack, MonadIO m) => IndexEntry -> m Text
indexEntryGetUid :: (HasCallStack, MonadIO m) => IndexEntry -> m Word32
indexEntryIsConflict :: (HasCallStack, MonadIO m) => IndexEntry -> m Bool
indexEntryRef :: (HasCallStack, MonadIO m) => IndexEntry -> m (Maybe IndexEntry)
indexEntrySetCommit :: (HasCallStack, MonadIO m, IsCommit a) => IndexEntry -> a -> m ()
indexEntrySetDev :: (HasCallStack, MonadIO m) => IndexEntry -> Word32 -> m ()
indexEntrySetFileSize :: (HasCallStack, MonadIO m) => IndexEntry -> Int64 -> m ()
indexEntrySetFlags :: (HasCallStack, MonadIO m) => IndexEntry -> Word32 -> m ()
indexEntrySetFlagsExtended :: (HasCallStack, MonadIO m) => IndexEntry -> Word32 -> m ()
indexEntrySetGid :: (HasCallStack, MonadIO m) => IndexEntry -> Word32 -> m ()
indexEntrySetId :: (HasCallStack, MonadIO m) => IndexEntry -> Maybe OId -> m ()
indexEntrySetIno :: (HasCallStack, MonadIO m) => IndexEntry -> Word32 -> m ()
indexEntrySetMode :: (HasCallStack, MonadIO m) => IndexEntry -> Word32 -> m ()
indexEntrySetPath :: (HasCallStack, MonadIO m) => IndexEntry -> Maybe Text -> m ()
indexEntrySetUid :: (HasCallStack, MonadIO m) => IndexEntry -> Word32 -> m ()
indexEntryStat :: (HasCallStack, MonadIO m, IsFile a) => IndexEntry -> a -> m ()
indexEntryUnref :: (HasCallStack, MonadIO m) => IndexEntry -> m ()

Exported types

newtype IndexEntry Source #

Memory-managed wrapper type.

Constructors

IndexEntry (ManagedPtr IndexEntry)

Instances

BoxedObject IndexEntry Source #
Instance details Defined in GI.Ggit.Structs.IndexEntry Methods boxedType :: IndexEntry -> IO GType #

noIndexEntry :: Maybe IndexEntry Source #

A convenience alias for Nothing :: Maybe IndexEntry.

Methods

getDev

indexEntryGetDev Source #

Arguments

:: (HasCallStack, MonadIO m)
=> IndexEntry	`entry`: a `IndexEntry`.
-> m Word32	Returns: the dev.

Get the dev of the index entry.

getFileSize

indexEntryGetFileSize Source #

Arguments

:: (HasCallStack, MonadIO m)
=> IndexEntry	`entry`: a `IndexEntry`.
-> m Int64	Returns: the file size.

Get the file size of the index entry.

getFlags

indexEntryGetFlags Source #

Arguments

:: (HasCallStack, MonadIO m)
=> IndexEntry	`entry`: a `IndexEntry`.
-> m Word32	Returns: the flags.

Get the flags of the index entry.

getFlagsExtended

indexEntryGetFlagsExtended Source #

Arguments

:: (HasCallStack, MonadIO m)
=> IndexEntry	`entry`: a `IndexEntry`.
-> m Word32	Returns: the extended flags.

Get the extended flags of the index entry.

getGid

indexEntryGetGid Source #

Arguments

:: (HasCallStack, MonadIO m)
=> IndexEntry	`entry`: a `IndexEntry`.
-> m Word32	Returns: the gid.

Get the gid of the index entry.

getId

indexEntryGetId Source #

Arguments

:: (HasCallStack, MonadIO m)
=> IndexEntry	`entry`: a `IndexEntry`.
-> m (Maybe OId)	Returns: the oid or `Nothing`.

Get the oid of the index entry.

getIno

indexEntryGetIno Source #

Arguments

:: (HasCallStack, MonadIO m)
=> IndexEntry	`entry`: a `IndexEntry`.
-> m Word32	Returns: the ino.

Get the ino of the index entry.

getMode

indexEntryGetMode Source #

Arguments

:: (HasCallStack, MonadIO m)
=> IndexEntry	`entry`: a `IndexEntry`.
-> m Word32	Returns: the mode.

Get the mode of the index entry.

getPath

indexEntryGetPath :: (HasCallStack, MonadIO m) => IndexEntry -> m Text Source #

No description available in the introspection data.

getUid

indexEntryGetUid Source #

Arguments

:: (HasCallStack, MonadIO m)
=> IndexEntry	`entry`: a `IndexEntry`.
-> m Word32	Returns: the uid.

Get the uid of the index entry.

isConflict

indexEntryIsConflict Source #

Arguments

:: (HasCallStack, MonadIO m)
=> IndexEntry	`entry`: a `IndexEntry`.
-> m Bool	Returns: `True` if the entry is a conflict, or `False` otherwise.

Get whether the entry represents a conflict.

ref

indexEntryRef Source #

Arguments

:: (HasCallStack, MonadIO m)
=> IndexEntry	`entry`: a `IndexEntry`.
-> m (Maybe IndexEntry)	Returns: a `IndexEntry` or `Nothing`.

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

setCommit

indexEntrySetCommit Source #

Arguments

:: (HasCallStack, MonadIO m, IsCommit a)
=> IndexEntry	`entry`: a `IndexEntry`.
-> a	`commit`: a `Commit`.
-> m ()

Set the index entry to point to a given commit. This sets the index entry id to the commit id, changes the mode to GGIT_FILE_MODE_COMMIT and updates the timestamps to when the commit was made.

setDev

indexEntrySetDev Source #

Arguments

:: (HasCallStack, MonadIO m)
=> IndexEntry	`entry`: a `IndexEntry`.
-> Word32	`dev`: the dev.
-> m ()

Set the dev of the index entry.

setFileSize

indexEntrySetFileSize Source #

Arguments

:: (HasCallStack, MonadIO m)
=> IndexEntry	`entry`: a `IndexEntry`.
-> Int64	`fileSize`: the file size.
-> m ()

Set the file size of the index entry.

setFlags

indexEntrySetFlags Source #

Arguments

:: (HasCallStack, MonadIO m)
=> IndexEntry	`entry`: a `IndexEntry`.
-> Word32	`flags`: the flags.
-> m ()

Set the flags of the index entry.

setFlagsExtended

indexEntrySetFlagsExtended Source #

Arguments

:: (HasCallStack, MonadIO m)
=> IndexEntry	`entry`: a `IndexEntry`.
-> Word32	`flagsExtended`: the extended flags.
-> m ()

Set the extended flags of the index entry.

setGid

indexEntrySetGid Source #

Arguments

:: (HasCallStack, MonadIO m)
=> IndexEntry	`entry`: a `IndexEntry`.
-> Word32	`gid`: the gid.
-> m ()

Set the gid of the index entry.

setId

indexEntrySetId Source #

Arguments

:: (HasCallStack, MonadIO m)
=> IndexEntry	`entry`: a `IndexEntry`.
-> Maybe OId	`id`: the oid.
-> m ()

Set the oid of the index entry.

setIno

indexEntrySetIno Source #

Arguments

:: (HasCallStack, MonadIO m)
=> IndexEntry	`entry`: a `IndexEntry`.
-> Word32	`ino`: the ino.
-> m ()

Set the ino of the index entry.

setMode

indexEntrySetMode Source #

Arguments

:: (HasCallStack, MonadIO m)
=> IndexEntry	`entry`: a `IndexEntry`.
-> Word32	`mode`: the mode.
-> m ()

Set the mode of the index entry.

setPath

indexEntrySetPath Source #

Arguments

:: (HasCallStack, MonadIO m)
=> IndexEntry	`entry`: a `IndexEntry`.
-> Maybe Text	`path`: the path.
-> m ()

Set the path of the index entry. The path should be relative to the working directory.

setUid

indexEntrySetUid Source #

Arguments

:: (HasCallStack, MonadIO m)
=> IndexEntry	`entry`: a `IndexEntry`.
-> Word32	`uid`: the uid.
-> m ()

Set the uid of the index entry.

stat

indexEntryStat Source #

Arguments

:: (HasCallStack, MonadIO m, IsFile a)
=> IndexEntry	`entry`: a `IndexEntry`.
-> a	`file`: the file to stat.
-> m ()	(Can throw `GError`)

Fill the entry fields from statting file.

unref

indexEntryUnref Source #

Arguments

:: (HasCallStack, MonadIO m)
=> IndexEntry	`entry`: a `IndexEntry`.
-> m ()

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