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

Contents

Exported types
Methods

Description

Represents a tag object.

Synopsis

newtype Tag = Tag (ManagedPtr Tag)
class GObject o => IsTag o
toTag :: (MonadIO m, IsTag o) => o -> m Tag
noTag :: Maybe Tag
tagGetMessage :: (HasCallStack, MonadIO m, IsTag a) => a -> m (Maybe Text)
tagGetName :: (HasCallStack, MonadIO m, IsTag a) => a -> m (Maybe Text)
tagGetTagger :: (HasCallStack, MonadIO m, IsTag a) => a -> m (Maybe Signature)
tagGetTarget :: (HasCallStack, MonadIO m, IsTag a) => a -> m (Maybe Object)
tagGetTargetId :: (HasCallStack, MonadIO m, IsTag a) => a -> m (Maybe OId)
tagGetTargetType :: (HasCallStack, MonadIO m, IsTag a) => a -> m GType
tagPeel :: (HasCallStack, MonadIO m, IsTag a) => a -> m (Maybe Object)

Exported types

newtype Tag Source #

Memory-managed wrapper type.

Constructors

Tag (ManagedPtr Tag)

Instances

GObject Tag Source #
Instance details Defined in GI.Ggit.Objects.Tag Methods gobjectType :: Tag -> IO GType #
IsObject Tag Source #
Instance details Defined in GI.Ggit.Objects.Tag
IsNative Tag Source #
Instance details Defined in GI.Ggit.Objects.Tag
IsObject Tag Source #
Instance details Defined in GI.Ggit.Objects.Tag
IsObjectFactoryBase Tag Source #
Instance details Defined in GI.Ggit.Objects.Tag
IsTag Tag Source #
Instance details Defined in GI.Ggit.Objects.Tag

class GObject o => IsTag o Source #

Type class for types which can be safely cast to Tag, for instance with toTag.

Instances

(GObject a, (UnknownAncestorError Tag a :: Constraint)) => IsTag a Source #
Instance details Defined in GI.Ggit.Objects.Tag
IsTag Tag Source #
Instance details Defined in GI.Ggit.Objects.Tag

toTag :: (MonadIO m, IsTag o) => o -> m Tag Source #

Cast to Tag, for types for which this is known to be safe. For general casts, use castTo.

noTag :: Maybe Tag Source #

A convenience alias for Nothing :: Maybe Tag.

Methods

getMessage

tagGetMessage Source #

Arguments

:: (HasCallStack, MonadIO m, IsTag a)
=> a	`tag`: a `Tag`.
-> m (Maybe Text)	Returns: the message of the tag or `Nothing`.

Gets the message of tag.

getName

tagGetName Source #

Arguments

:: (HasCallStack, MonadIO m, IsTag a)
=> a	`tag`: a `Tag`.
-> m (Maybe Text)	Returns: the name of the tag or `Nothing`.

Gets the name of tag.

getTagger

tagGetTagger Source #

Arguments

:: (HasCallStack, MonadIO m, IsTag a)
=> a	`tag`: a `Tag`.
-> m (Maybe Signature)	Returns: the tagger (author) of the tag or `Nothing`.

Get the tagger (author) of tag. The returned value must be free with objectUnref.

getTarget

tagGetTarget Source #

Arguments

:: (HasCallStack, MonadIO m, IsTag a)
=> a	`tag`: a `Tag`.
-> m (Maybe Object)	Returns: the target `Object` of the tag or `Nothing`. (Can throw `GError`)

Gets the target Object of tag.

This method performs a repository lookup for the given object and returns it.

getTargetId

tagGetTargetId Source #

Arguments

:: (HasCallStack, MonadIO m, IsTag a)
=> a	`tag`: a `Tag`.
-> m (Maybe OId)	Returns: the target `OId` of the tag or `Nothing`.

Gets the target OId of tag.

getTargetType

tagGetTargetType Source #

Arguments

:: (HasCallStack, MonadIO m, IsTag a)
=> a	`tag`: a `Tag`.
-> m GType	Returns: a `GType`.

Get the target object type.

peel

tagPeel Source #

Arguments

:: (HasCallStack, MonadIO m, IsTag a)
=> a	`tag`: a `Tag`.
-> m (Maybe Object)	Returns: a `Object` or `Nothing`. (Can throw `GError`)

Recursively peel a tag until a non tag object is found.