GI.OSTree.Structs.RepoCommitTraverseIter

No description available in the introspection data.

Exported types

newtype RepoCommitTraverseIter

Memory-managed wrapper type.

Constructors

RepoCommitTraverseIter (ManagedPtr RepoCommitTraverseIter)

Instances

WrappedPtr RepoCommitTraverseIter

Defined in GI.OSTree.Structs.RepoCommitTraverseIter

Methods

wrappedPtrCalloc :: IO (Ptr RepoCommitTraverseIter)

wrappedPtrCopy :: RepoCommitTraverseIter -> IO RepoCommitTraverseIter

wrappedPtrFree :: Maybe (GDestroyNotify RepoCommitTraverseIter)

tag ~ AttrSet => Constructible RepoCommitTraverseIter tag

Defined in GI.OSTree.Structs.RepoCommitTraverseIter

Methods

new :: MonadIO m => (ManagedPtr RepoCommitTraverseIter -> RepoCommitTraverseIter) -> [AttrOp RepoCommitTraverseIter tag] -> m RepoCommitTraverseIter

newZeroRepoCommitTraverseIter :: MonadIO m => m RepoCommitTraverseIter

Construct a RepoCommitTraverseIter struct initialized to zero.

noRepoCommitTraverseIter :: Maybe RepoCommitTraverseIter

A convenience alias for Nothing :: Maybe RepoCommitTraverseIter.

Methods

cleanup

repoCommitTraverseIterCleanup :: (HasCallStack, MonadIO m) => Ptr () -> m ()

No description available in the introspection data.

clear

repoCommitTraverseIterClear :: (HasCallStack, MonadIO m) => RepoCommitTraverseIter -> m ()

No description available in the introspection data.

getDir

repoCommitTraverseIterGetDir

Arguments

:: (HasCallStack, MonadIO m)

=> RepoCommitTraverseIter

iter: An iter

-> m (Text, Text, Text)

Return information on the current directory. This function may only be called if RepoCommitIterResultDir was returned from repoCommitTraverseIterNext.

getFile

repoCommitTraverseIterGetFile

Arguments

:: (HasCallStack, MonadIO m)

=> RepoCommitTraverseIter

iter: An iter

-> m (Text, Text)

Return information on the current file. This function may only be called if RepoCommitIterResultFile was returned from repoCommitTraverseIterNext.

initCommit

repoCommitTraverseIterInitCommit

Arguments

:: (HasCallStack, MonadIO m, IsRepo a)

=> RepoCommitTraverseIter

iter: An iter

-> a

repo: A repo

-> GVariant

commit: Variant of type ObjectTypeCommit

-> [RepoCommitTraverseFlags]

flags: Flags

-> m ()

(Can throw GError)

Initialize (in place) an iterator over the root of a commit object.

initDirtree

repoCommitTraverseIterInitDirtree

Arguments

:: (HasCallStack, MonadIO m, IsRepo a)

=> RepoCommitTraverseIter

iter: An iter

-> a

repo: A repo

-> GVariant

dirtree: Variant of type ObjectTypeDirTree

-> [RepoCommitTraverseFlags]

flags: Flags

-> m ()

(Can throw GError)

Initialize (in place) an iterator over a directory tree.

next

repoCommitTraverseIterNext

Arguments

:: (HasCallStack, MonadIO m, IsCancellable a)

=> RepoCommitTraverseIter

iter: An iter

-> Maybe a

cancellable: Cancellable

-> m RepoCommitIterResult

(Can throw GError)

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

Get the value of the “initialized” field. When overloading is enabled, this is equivalent to

get repoCommitTraverseIter #initialized

setRepoCommitTraverseIterInitialized :: MonadIO m => RepoCommitTraverseIter -> Bool -> m ()

Set the value of the “initialized” field. When overloading is enabled, this is equivalent to

set repoCommitTraverseIter [ #initialized := value ]