gi-ggit-1.0.14: 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.Objects.Tag

Description

Represents a tag object.

Synopsis

Exported types

newtype Tag Source #

Memory-managed wrapper type.

Constructors

Tag (ManagedPtr Tag) 

Instances

Instances details
Eq Tag Source # 
Instance details

Defined in GI.Ggit.Objects.Tag

Methods

(==) :: Tag -> Tag -> Bool #

(/=) :: Tag -> Tag -> Bool #

GObject Tag Source # 
Instance details

Defined in GI.Ggit.Objects.Tag

ManagedPtrNewtype Tag Source # 
Instance details

Defined in GI.Ggit.Objects.Tag

Methods

toManagedPtr :: Tag -> ManagedPtr Tag

TypedObject Tag Source # 
Instance details

Defined in GI.Ggit.Objects.Tag

Methods

glibType :: IO GType

HasParentTypes Tag Source # 
Instance details

Defined in GI.Ggit.Objects.Tag

IsGValue (Maybe Tag) Source #

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

Instance details

Defined in GI.Ggit.Objects.Tag

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes Tag Source # 
Instance details

Defined in GI.Ggit.Objects.Tag

type ParentTypes Tag = '[Object, Native, ObjectFactoryBase, Object]

class (GObject o, IsDescendantOf Tag o) => IsTag o Source #

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

Instances

Instances details
(GObject o, IsDescendantOf Tag o) => IsTag o 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.

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.