GI.Ggit.Structs.Reflog

Represents a reflog.

Exported types

newtype Reflog

Constructors

Reflog (ManagedPtr Reflog)

Instances

BoxedObject Reflog

Methods

boxedType :: Reflog -> IO GType

noReflog :: Maybe Reflog

Methods

append

reflogAppend

Arguments

:: (HasCallStack, MonadIO m, IsSignature a)

=> Reflog

reflog: a Reflog.

-> OId

oid: a OId.

-> a

committer: a Signature.

-> Text

message: the message.

-> m ()

(Can throw GError)

Creates a reflog entry.

getEntryCount

reflogGetEntryCount

Arguments

:: (HasCallStack, MonadIO m)

=> Reflog

reflog: a Reflog.

-> m Word32

Returns: the number of log entries.

Gets the number of log entries in reflog.

getEntryFromIndex

reflogGetEntryFromIndex

Arguments

:: (HasCallStack, MonadIO m)

=> Reflog

reflog: a Reflog.

-> Word32

idx: the position to lookup.

-> m ReflogEntry

Returns: the reflog entry at the index, or Nothing if not found.

Gets the ReflogEntry at idx in reflog, or Nothing if not found.

ref

reflogRef

Arguments

:: (HasCallStack, MonadIO m)

=> Reflog

reflog: a Reflog.

-> m Reflog

Returns: the passed in Reflog.

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

rename

reflogRename

Arguments

:: (HasCallStack, MonadIO m)

=> Reflog

reflog: a Reflog.

-> Text

newName: the new name of the reference.

-> m ()

(Can throw GError)

Renames the reflog for to newName, on error error is set.

unref

reflogUnref

Arguments

:: (HasCallStack, MonadIO m)

=> Reflog

reflog: a Reflog.

-> m ()

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

write

reflogWrite

Arguments

:: (HasCallStack, MonadIO m)

=> Reflog

reflog: a Reflog.

-> m ()

(Can throw GError)

Write the reflog to disk.