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.RefSpec

Contents

Exported types
Methods

Description

Reprensents a git reference specification.

Synopsis

newtype RefSpec = RefSpec (ManagedPtr RefSpec)
refSpecGetDestination :: (HasCallStack, MonadIO m) => RefSpec -> m (Maybe Text)
refSpecGetSource :: (HasCallStack, MonadIO m) => RefSpec -> m (Maybe Text)
refSpecIsForced :: (HasCallStack, MonadIO m) => RefSpec -> m Bool
refSpecRef :: (HasCallStack, MonadIO m) => RefSpec -> m (Maybe RefSpec)
refSpecUnref :: (HasCallStack, MonadIO m) => RefSpec -> m ()

Exported types

newtype RefSpec Source #

Memory-managed wrapper type.

Constructors

RefSpec (ManagedPtr RefSpec)

Instances

Instances details

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

Methods

Click to display all available methods, including inherited ones

Expand

Methods

isForced, ref, unref.

Getters

getDestination, getSource.

Setters

None.

getDestination

refSpecGetDestination Source #

Arguments

:: (HasCallStack, MonadIO m)
=> RefSpec	`refspec`: a `RefSpec`.
-> m (Maybe Text)	Returns: the refspec's destination or `Nothing`.

Gets the refspec's destination.

getSource

refSpecGetSource Source #

Arguments

:: (HasCallStack, MonadIO m)
=> RefSpec	`refspec`: a `RefSpec`.
-> m (Maybe Text)	Returns: the refspec's source or `Nothing`.

Gets the refspec's source.

isForced

refSpecIsForced Source #

Arguments

:: (HasCallStack, MonadIO m)
=> RefSpec	`refspec`: a `RefSpec`.
-> m Bool	Returns: if updating is done forcefully.

Whether updating is done forcefully.

ref

refSpecRef Source #

Arguments

:: (HasCallStack, MonadIO m)
=> RefSpec	`refspec`: a `RefSpec`.
-> m (Maybe RefSpec)	Returns: a `RefSpec` or `Nothing`.

Atomically increments the reference count of refspec by one. This function is MT-safe and may be called from any thread.

unref

refSpecUnref Source #

Arguments

:: (HasCallStack, MonadIO m)
=> RefSpec	`refspec`: a `RefSpec`.
-> m ()

Atomically decrements the reference count of refspec by one. If the reference count drops to 0, refspec is freed.