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

Contents

Exported types
Methods

Description

Represents a branch enumerator.

Synopsis

newtype BranchEnumerator = BranchEnumerator (ManagedPtr BranchEnumerator)
branchEnumeratorGet :: (HasCallStack, MonadIO m) => BranchEnumerator -> m (Maybe Ref)
branchEnumeratorIterator :: (HasCallStack, MonadIO m) => BranchEnumerator -> m (Maybe BranchEnumerator)
branchEnumeratorNext :: (HasCallStack, MonadIO m) => BranchEnumerator -> m Bool
branchEnumeratorRef :: (HasCallStack, MonadIO m) => BranchEnumerator -> m (Maybe BranchEnumerator)
branchEnumeratorUnref :: (HasCallStack, MonadIO m) => BranchEnumerator -> m ()

Exported types

newtype BranchEnumerator Source #

Memory-managed wrapper type.

Constructors

BranchEnumerator (ManagedPtr BranchEnumerator)

Instances

Instances details

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

Methods

Click to display all available methods, including inherited ones

Expand

Methods

get, iterator, next, ref, unref.

Getters

None.

Setters

None.

get

branchEnumeratorGet Source #

Arguments

:: (HasCallStack, MonadIO m)
=> BranchEnumerator	`enumerator`: a `BranchEnumerator`.
-> m (Maybe Ref)	Returns: the branch ref or `Nothing`.

Returns the currently being enumerated branch, or Nothing. Note that the returned GgitRef will be of type GgitBranch if the ref represents a local branch.

iterator

branchEnumeratorIterator Source #

Arguments

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

Get an iterator for the enumerator.

ref

branchEnumeratorRef Source #

Arguments

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

No description available in the introspection data.

unref

branchEnumeratorUnref Source #

Arguments

:: (HasCallStack, MonadIO m)
=> BranchEnumerator	`enumerator`: a `BranchEnumerator`.
-> m ()

No description available in the introspection data.