| Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria (inaki@blueleaf.cc) |
| Safe Haskell | None |
| Language | Haskell2010 |
GI.Ggit.Structs.AnnotatedCommit
Contents
Description
Represents an annotated commit object.
Synopsis
- newtype AnnotatedCommit = AnnotatedCommit (ManagedPtr AnnotatedCommit)
- noAnnotatedCommit :: Maybe AnnotatedCommit
- annotatedCommitGetId :: (HasCallStack, MonadIO m) => AnnotatedCommit -> m (Maybe OId)
- annotatedCommitNewFromRef :: (HasCallStack, MonadIO m, IsRepository a, IsRef b) => a -> b -> m AnnotatedCommit
- annotatedCommitRef :: (HasCallStack, MonadIO m) => AnnotatedCommit -> m (Maybe AnnotatedCommit)
- annotatedCommitUnref :: (HasCallStack, MonadIO m) => AnnotatedCommit -> m ()
Exported types
newtype AnnotatedCommit Source #
Memory-managed wrapper type.
Constructors
| AnnotatedCommit (ManagedPtr AnnotatedCommit) |
Instances
| BoxedObject AnnotatedCommit Source # | |
Defined in GI.Ggit.Structs.AnnotatedCommit Methods boxedType :: AnnotatedCommit -> IO GType # | |
noAnnotatedCommit :: Maybe AnnotatedCommit Source #
A convenience alias for Nothing :: Maybe AnnotatedCommit.
Methods
getId
Arguments
| :: (HasCallStack, MonadIO m) | |
| => AnnotatedCommit |
|
| -> m (Maybe OId) | Returns: the commit ID that the given |
Gets the commit ID that the given annotatedCommit refs to.
newFromRef
annotatedCommitNewFromRef Source #
Arguments
| :: (HasCallStack, MonadIO m, IsRepository a, IsRef b) | |
| => a |
|
| -> b |
|
| -> m AnnotatedCommit | Returns: a |
Create a GgitAnnotatedCommit from the given reference
ref
Arguments
| :: (HasCallStack, MonadIO m) | |
| => AnnotatedCommit |
|
| -> m (Maybe 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.