gi-ggit-1.0.8: libgit2-glib bindings

CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellNone
LanguageHaskell2010

GI.Ggit.Structs.AnnotatedCommit

Contents

Description

Represents an annotated commit object.

Synopsis

Exported types

newtype AnnotatedCommit Source #

Memory-managed wrapper type.

Constructors

AnnotatedCommit (ManagedPtr AnnotatedCommit) 
Instances
Eq AnnotatedCommit Source # 
Instance details

Defined in GI.Ggit.Structs.AnnotatedCommit

BoxedObject AnnotatedCommit Source # 
Instance details

Defined in GI.Ggit.Structs.AnnotatedCommit

Methods

boxedType :: AnnotatedCommit -> IO GType

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

noAnnotatedCommit :: Maybe AnnotatedCommit Source #

A convenience alias for Nothing :: Maybe AnnotatedCommit.

Methods

Overloaded methods

getId

annotatedCommitGetId Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> AnnotatedCommit

annotatedCommit: a tAnnotatedCommit.

-> 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.

newFromRef

annotatedCommitNewFromRef Source #

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 tAnnotatedCommit. (Can throw GError)

Create a GgitAnnotatedCommit from the given reference

ref

annotatedCommitRef Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> AnnotatedCommit

annotatedCommit: a tAnnotatedCommit.

-> m (Maybe AnnotatedCommit)

Returns: a newly allocated tAnnotatedCommit or Nothing.

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

unref

annotatedCommitUnref Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> AnnotatedCommit

annotatedCommit: a tAnnotatedCommit.

-> m () 

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