gi-ggit-1.0.15: libgit2-glib bindings
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellSafe-Inferred
LanguageHaskell2010

GI.Ggit.Structs.AnnotatedCommit

Description

Represents an annotated commit object.

Synopsis

Exported types

newtype AnnotatedCommit Source #

Memory-managed wrapper type.

Constructors

AnnotatedCommit (ManagedPtr AnnotatedCommit) 

Instances

Instances details
Eq AnnotatedCommit Source # 
Instance details

Defined in GI.Ggit.Structs.AnnotatedCommit

GBoxed AnnotatedCommit Source # 
Instance details

Defined in GI.Ggit.Structs.AnnotatedCommit

ManagedPtrNewtype AnnotatedCommit Source # 
Instance details

Defined in GI.Ggit.Structs.AnnotatedCommit

TypedObject AnnotatedCommit Source # 
Instance details

Defined in GI.Ggit.Structs.AnnotatedCommit

Methods

glibType :: IO GType

HasParentTypes AnnotatedCommit Source # 
Instance details

Defined in GI.Ggit.Structs.AnnotatedCommit

IsGValue (Maybe AnnotatedCommit) Source #

Convert AnnotatedCommit to and from GValue. See toGValue and fromGValue.

Instance details

Defined in GI.Ggit.Structs.AnnotatedCommit

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe AnnotatedCommit -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe AnnotatedCommit)

type ParentTypes AnnotatedCommit Source # 
Instance details

Defined in GI.Ggit.Structs.AnnotatedCommit

type ParentTypes AnnotatedCommit = '[] :: [Type]

Methods

Click to display all available methods, including inherited ones

Expand

Methods

ref, unref.

Getters

getId.

Setters

None.

getId

annotatedCommitGetId Source #

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.

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

Create a GgitAnnotatedCommit from the given reference

ref

annotatedCommitRef Source #

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.

unref

annotatedCommitUnref Source #

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.