| 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.Note
Contents
Description
Represents a note object.
- newtype Note = Note (ManagedPtr Note)
- noNote :: Maybe Note
- noteGetId :: (HasCallStack, MonadIO m) => Note -> m OId
- noteGetMessage :: (HasCallStack, MonadIO m) => Note -> m Text
- noteRef :: (HasCallStack, MonadIO m) => Note -> m Note
- noteUnref :: (HasCallStack, MonadIO m) => Note -> m ()
Exported types
Methods
getId
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Note |
|
| -> m OId | Returns: the object's id. |
Gets the note object's id.
getMessage
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Note |
|
| -> m Text | Returns: the note message. |
Gets the note message.
ref
Atomically increments the reference count of note by one.
This function is MT-safe and may be called from any thread.