Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | None |
Language | Haskell2010 |
No description available in the introspection data.
Synopsis
- newtype RepoCommitTraverseIter = RepoCommitTraverseIter (ManagedPtr RepoCommitTraverseIter)
- newZeroRepoCommitTraverseIter :: MonadIO m => m RepoCommitTraverseIter
- repoCommitTraverseIterCleanup :: (HasCallStack, MonadIO m) => Ptr () -> m ()
- repoCommitTraverseIterClear :: (HasCallStack, MonadIO m) => RepoCommitTraverseIter -> m ()
- repoCommitTraverseIterGetDir :: (HasCallStack, MonadIO m) => RepoCommitTraverseIter -> m (Text, Text, Text)
- repoCommitTraverseIterGetFile :: (HasCallStack, MonadIO m) => RepoCommitTraverseIter -> m (Text, Text)
- repoCommitTraverseIterInitCommit :: (HasCallStack, MonadIO m, IsRepo a) => RepoCommitTraverseIter -> a -> GVariant -> [RepoCommitTraverseFlags] -> m ()
- repoCommitTraverseIterInitDirtree :: (HasCallStack, MonadIO m, IsRepo a) => RepoCommitTraverseIter -> a -> GVariant -> [RepoCommitTraverseFlags] -> m ()
- repoCommitTraverseIterNext :: (HasCallStack, MonadIO m, IsCancellable a) => RepoCommitTraverseIter -> Maybe a -> m RepoCommitIterResult
- getRepoCommitTraverseIterInitialized :: MonadIO m => RepoCommitTraverseIter -> m Bool
- setRepoCommitTraverseIterInitialized :: MonadIO m => RepoCommitTraverseIter -> Bool -> m ()
Exported types
newtype RepoCommitTraverseIter Source #
Memory-managed wrapper type.
RepoCommitTraverseIter (ManagedPtr RepoCommitTraverseIter) |
Instances
newZeroRepoCommitTraverseIter :: MonadIO m => m RepoCommitTraverseIter Source #
Construct a RepoCommitTraverseIter
struct initialized to zero.
Methods
Overloaded methods
cleanup
repoCommitTraverseIterCleanup :: (HasCallStack, MonadIO m) => Ptr () -> m () Source #
No description available in the introspection data.
clear
repoCommitTraverseIterClear :: (HasCallStack, MonadIO m) => RepoCommitTraverseIter -> m () Source #
No description available in the introspection data.
getDir
repoCommitTraverseIterGetDir Source #
:: (HasCallStack, MonadIO m) | |
=> RepoCommitTraverseIter |
|
-> m (Text, Text, Text) |
Return information on the current directory. This function may
only be called if RepoCommitIterResultDir
was returned
from repoCommitTraverseIterNext
.
getFile
repoCommitTraverseIterGetFile Source #
:: (HasCallStack, MonadIO m) | |
=> RepoCommitTraverseIter |
|
-> m (Text, Text) |
Return information on the current file. This function may only be
called if RepoCommitIterResultFile
was returned from
repoCommitTraverseIterNext
.
initCommit
repoCommitTraverseIterInitCommit Source #
:: (HasCallStack, MonadIO m, IsRepo a) | |
=> RepoCommitTraverseIter |
|
-> a |
|
-> GVariant |
|
-> [RepoCommitTraverseFlags] |
|
-> m () | (Can throw |
Initialize (in place) an iterator over the root of a commit object.
initDirtree
repoCommitTraverseIterInitDirtree Source #
:: (HasCallStack, MonadIO m, IsRepo a) | |
=> RepoCommitTraverseIter |
|
-> a |
|
-> GVariant |
|
-> [RepoCommitTraverseFlags] |
|
-> m () | (Can throw |
Initialize (in place) an iterator over a directory tree.
next
repoCommitTraverseIterNext Source #
:: (HasCallStack, MonadIO m, IsCancellable a) | |
=> RepoCommitTraverseIter |
|
-> Maybe a |
|
-> m RepoCommitIterResult | (Can throw |
Step the interator to the next item. Files will be returned first,
then subdirectories. Call this in a loop; upon encountering
RepoCommitIterResultEnd
, there will be no more files or
directories. If RepoCommitIterResultDir
is returned,
then call repoCommitTraverseIterGetDir
to retrieve
data for that directory. Similarly, if
RepoCommitIterResultFile
is returned, call
repoCommitTraverseIterGetFile
.
If RepoCommitIterResultError
is returned, it is a
program error to call any further API on iter
except for
repoCommitTraverseIterClear
.
Properties
initialized
No description available in the introspection data.
getRepoCommitTraverseIterInitialized :: MonadIO m => RepoCommitTraverseIter -> m Bool Source #
Get the value of the “initialized
” field.
When overloading is enabled, this is equivalent to
get
repoCommitTraverseIter #initialized
setRepoCommitTraverseIterInitialized :: MonadIO m => RepoCommitTraverseIter -> Bool -> m () Source #
Set the value of the “initialized
” field.
When overloading is enabled, this is equivalent to
set
repoCommitTraverseIter [ #initialized:=
value ]