Copyright	Will Thompson Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria
Safe Haskell	None
Language	Haskell2010

GI.Ggit.Structs.AnnotatedCommit

Contents

Description

Represents an annotated commit object.

Synopsis

Exported types

Memory-managed wrapper type.

Constructors

Instances details

Eq AnnotatedCommit Source #
Instance details Defined in GI.Ggit.Structs.AnnotatedCommit Methods (==) :: AnnotatedCommit -> AnnotatedCommit -> Bool # (/=) :: AnnotatedCommit -> AnnotatedCommit -> Bool #
IsGValue AnnotatedCommit Source #	Convert `AnnotatedCommit` to and from `GValue` with `toGValue` and `fromGValue`.
Instance details Defined in GI.Ggit.Structs.AnnotatedCommit Methods toGValue :: AnnotatedCommit -> IO GValue # fromGValue :: GValue -> IO AnnotatedCommit #
BoxedObject AnnotatedCommit Source #
Instance details Defined in GI.Ggit.Structs.AnnotatedCommit Methods boxedType :: AnnotatedCommit -> IO GType #

A convenience alias for Nothing :: Maybe AnnotatedCommit.

Methods

Arguments

:: (HasCallStack, MonadIO m)
=> AnnotatedCommit	`annotatedCommit`: a `AnnotatedCommit`.
-> m (Maybe OId)	Returns: the commit ID that the given `annotatedCommit` refs to or `Nothing`.

Gets the commit ID that the given annotatedCommit refs to.

Arguments

:: (HasCallStack, MonadIO m, IsRepository a, IsRef b)
=> a	`repository`: the repository
-> b	`ref`: the reference to use to lookup the git_annotated_commit
-> m AnnotatedCommit	Returns: a `AnnotatedCommit`. (Can throw `GError`)

Create a GgitAnnotatedCommit from the given reference

Arguments

:: (HasCallStack, MonadIO m)
=> AnnotatedCommit	`annotatedCommit`: a `AnnotatedCommit`.
-> m (Maybe AnnotatedCommit)	Returns: a newly allocated `AnnotatedCommit` or `Nothing`.

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

Arguments

:: (HasCallStack, MonadIO m)
=> AnnotatedCommit	`annotatedCommit`: a `AnnotatedCommit`.
-> m ()

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