gi-ggit-1.0.8: libgit2-glib bindings

CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellNone
LanguageHaskell2010

GI.Ggit.Structs.BranchEnumerator

Contents

Description

Represents a branch enumerator.

Synopsis

Exported types

newtype BranchEnumerator Source #

Memory-managed wrapper type.

Constructors

BranchEnumerator (ManagedPtr BranchEnumerator) 
Instances
Eq BranchEnumerator Source # 
Instance details

Defined in GI.Ggit.Structs.BranchEnumerator

BoxedObject BranchEnumerator Source # 
Instance details

Defined in GI.Ggit.Structs.BranchEnumerator

Methods

boxedType :: BranchEnumerator -> IO GType

IsGValue BranchEnumerator Source #

Convert BranchEnumerator to and from GValue with toGValue and fromGValue.

Instance details

Defined in GI.Ggit.Structs.BranchEnumerator

Methods

toGValue :: BranchEnumerator -> IO GValue

fromGValue :: GValue -> IO BranchEnumerator

noBranchEnumerator :: Maybe BranchEnumerator Source #

A convenience alias for Nothing :: Maybe BranchEnumerator.

Methods

Overloaded methods

get

branchEnumeratorGet Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> BranchEnumerator

enumerator: a tBranchEnumerator.

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

-> m (Maybe BranchEnumerator)

Returns: a tBranchEnumerator or Nothing.

Get an iterator for the enumerator.

next

branchEnumeratorNext Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> BranchEnumerator

enumerator: a tBranchEnumerator.

-> m Bool

Returns: True if there is a next branch, False otherwise.

Move the enumerator to the next branch.

ref

branchEnumeratorRef Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> BranchEnumerator

enumerator: a tBranchEnumerator.

-> m (Maybe BranchEnumerator)

Returns: enumerator or Nothing

No description available in the introspection data.

unref

branchEnumeratorUnref Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> BranchEnumerator

enumerator: a tBranchEnumerator.

-> m () 

No description available in the introspection data.