Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria (garetxe@gmail.com) |
Safe Haskell | None |
Language | Haskell2010 |
Represents a branch enumerator.
Synopsis
- newtype BranchEnumerator = BranchEnumerator (ManagedPtr BranchEnumerator)
- noBranchEnumerator :: Maybe 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.
Instances
BoxedObject BranchEnumerator Source # | |
Defined in GI.Ggit.Structs.BranchEnumerator boxedType :: BranchEnumerator -> IO GType # |
noBranchEnumerator :: Maybe BranchEnumerator Source #
A convenience alias for Nothing
:: Maybe
BranchEnumerator
.
Methods
get
:: (HasCallStack, MonadIO m) | |
=> BranchEnumerator |
|
-> m (Maybe Ref) | Returns: the branch ref or |
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 #
:: (HasCallStack, MonadIO m) | |
=> BranchEnumerator |
|
-> m (Maybe BranchEnumerator) | Returns: a |
Get an iterator for the enumerator.
next
:: (HasCallStack, MonadIO m) | |
=> BranchEnumerator |
|
-> m Bool |
Move the enumerator to the next branch.
ref
:: (HasCallStack, MonadIO m) | |
=> BranchEnumerator |
|
-> m (Maybe BranchEnumerator) | Returns: |
No description available in the introspection data.
unref
branchEnumeratorUnref Source #
:: (HasCallStack, MonadIO m) | |
=> BranchEnumerator |
|
-> m () |
No description available in the introspection data.