gi-ggit-1.0.11: libgit2-glib bindings

Copyright	Will Thompson and Iñaki García Etxebarria
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria
Safe Haskell	Safe-Inferred
Language	Haskell2010

GI.Ggit.Structs.RemoteHead

Contents

Exported types
Methods

Description

Represents a git remote head.

Synopsis

newtype RemoteHead = RemoteHead (ManagedPtr RemoteHead)
remoteHeadGetLocalOid :: (HasCallStack, MonadIO m) => RemoteHead -> m (Maybe OId)
remoteHeadGetName :: (HasCallStack, MonadIO m) => RemoteHead -> m (Maybe Text)
remoteHeadGetOid :: (HasCallStack, MonadIO m) => RemoteHead -> m (Maybe OId)
remoteHeadIsLocal :: (HasCallStack, MonadIO m) => RemoteHead -> m Bool
remoteHeadRef :: (HasCallStack, MonadIO m) => RemoteHead -> m RemoteHead
remoteHeadUnref :: (HasCallStack, MonadIO m) => RemoteHead -> m ()

Exported types

newtype RemoteHead Source #

Memory-managed wrapper type.

Constructors

RemoteHead (ManagedPtr RemoteHead)

Instances

Instances details

Eq RemoteHead Source #
Instance details Defined in GI.Ggit.Structs.RemoteHead Methods (==) :: RemoteHead -> RemoteHead -> Bool # (/=) :: RemoteHead -> RemoteHead -> Bool #
GBoxed RemoteHead Source #
Instance details Defined in GI.Ggit.Structs.RemoteHead
ManagedPtrNewtype RemoteHead Source #
Instance details Defined in GI.Ggit.Structs.RemoteHead Methods toManagedPtr :: RemoteHead -> ManagedPtr RemoteHead #
TypedObject RemoteHead Source #
Instance details Defined in GI.Ggit.Structs.RemoteHead Methods glibType :: IO GType #
HasParentTypes RemoteHead Source #
Instance details Defined in GI.Ggit.Structs.RemoteHead
IsGValue (Maybe RemoteHead) Source #	Convert `RemoteHead` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details Defined in GI.Ggit.Structs.RemoteHead Methods gvalueGType_ :: IO GType # gvalueSet_ :: Ptr GValue -> Maybe RemoteHead -> IO () # gvalueGet_ :: Ptr GValue -> IO (Maybe RemoteHead) #
type ParentTypes RemoteHead Source #
Instance details Defined in GI.Ggit.Structs.RemoteHead type ParentTypes RemoteHead = '[] :: [Type]

Methods

Click to display all available methods, including inherited ones

Expand

Methods

isLocal, ref, unref.

Getters

getLocalOid, getName, getOid.

Setters

None.

getLocalOid

remoteHeadGetLocalOid Source #

Arguments

:: (HasCallStack, MonadIO m)
=> RemoteHead	`remoteHead`: a `RemoteHead`.
-> m (Maybe OId)	Returns: the local oid or `Nothing`.

Get the local oid of the remote head.

getName

remoteHeadGetName Source #

Arguments

:: (HasCallStack, MonadIO m)
=> RemoteHead	`remoteHead`: a `RemoteHead`.
-> m (Maybe Text)	Returns: the remote head name or `Nothing`.

Get the remote head name.

getOid

remoteHeadGetOid Source #

Arguments

:: (HasCallStack, MonadIO m)
=> RemoteHead	`remoteHead`: a `RemoteHead`.
-> m (Maybe OId)	Returns: the remote oid or `Nothing`.

Get the remote oid of the remote head.

isLocal

remoteHeadIsLocal Source #

Arguments

:: (HasCallStack, MonadIO m)
=> RemoteHead	`remoteHead`: a `RemoteHead`.
-> m Bool	Returns: whether the remote head is local.

Get whether the remote head is local.

ref

remoteHeadRef :: (HasCallStack, MonadIO m) => RemoteHead -> m RemoteHead Source #

No description available in the introspection data.

unref

remoteHeadUnref :: (HasCallStack, MonadIO m) => RemoteHead -> m () Source #

No description available in the introspection data.