gi-ostree-1.0.18: OSTree bindings
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellSafe-Inferred
LanguageHaskell2010

GI.OSTree.Structs.RepoCommitTraverseIter

Description

No description available in the introspection data.

Synopsis

Exported types

Methods

Click to display all available methods, including inherited ones

Expand

Methods

clear, initCommit, initDirtree, next.

Getters

getDir, getFile.

Setters

None.

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 #

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 Source #

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 Source #

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 Source #

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 Source #

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 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 ]