| Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria (garetxe@gmail.com) |
| Safe Haskell | None |
| Language | Haskell2010 |
GI.Ggit.Structs.AnnotatedCommit
Contents
Description
Represents an annotated commit object.
- newtype AnnotatedCommit = AnnotatedCommit (ManagedPtr AnnotatedCommit)
- noAnnotatedCommit :: Maybe AnnotatedCommit
- annotatedCommitGetId :: (HasCallStack, MonadIO m) => AnnotatedCommit -> m OId
- annotatedCommitRef :: (HasCallStack, MonadIO m) => AnnotatedCommit -> m AnnotatedCommit
- annotatedCommitUnref :: (HasCallStack, MonadIO m) => AnnotatedCommit -> m ()
Exported types
Methods
getId
Arguments
| :: (HasCallStack, MonadIO m) | |
| => AnnotatedCommit |
|
| -> m OId | Returns: the commit ID that the given |
Gets the commit ID that the given annotatedCommit refs to.
ref
Arguments
| :: (HasCallStack, MonadIO m) | |
| => AnnotatedCommit |
|
| -> m AnnotatedCommit | Returns: a newly allocated |
Atomically increments the reference count of annotatedCommit by one.
This function is MT-safe and may be called from any thread.
unref
Arguments
| :: (HasCallStack, MonadIO m) | |
| => AnnotatedCommit |
|
| -> m () |
Atomically decrements the reference count of annotatedCommit by one.
If the reference count drops to 0, annotatedCommit is freed.