Copyright	Will Thompson and Iñaki García Etxebarria
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria
Safe Haskell	Safe-Inferred
Language	Haskell2010

GI.OSTree.Structs.RepoCommitTraverseIter

Contents

Exported types
Methods
Properties
- initialized

Description

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.

Constructors

RepoCommitTraverseIter (ManagedPtr RepoCommitTraverseIter)

Instances

Instances details

Eq RepoCommitTraverseIter Source #
Instance details Defined in GI.OSTree.Structs.RepoCommitTraverseIter Methods (==) :: RepoCommitTraverseIter -> RepoCommitTraverseIter -> Bool # (/=) :: RepoCommitTraverseIter -> RepoCommitTraverseIter -> Bool #
BoxedPtr RepoCommitTraverseIter Source #
Instance details Defined in GI.OSTree.Structs.RepoCommitTraverseIter Methods boxedPtrCopy :: RepoCommitTraverseIter -> IO RepoCommitTraverseIter boxedPtrFree :: RepoCommitTraverseIter -> IO ()
CallocPtr RepoCommitTraverseIter Source #
Instance details Defined in GI.OSTree.Structs.RepoCommitTraverseIter Methods boxedPtrCalloc :: IO (Ptr RepoCommitTraverseIter)
ManagedPtrNewtype RepoCommitTraverseIter Source #
Instance details Defined in GI.OSTree.Structs.RepoCommitTraverseIter Methods toManagedPtr :: RepoCommitTraverseIter -> ManagedPtr RepoCommitTraverseIter
tag ~ 'AttrSet => Constructible RepoCommitTraverseIter tag Source #
Instance details Defined in GI.OSTree.Structs.RepoCommitTraverseIter Methods new :: MonadIO m => (ManagedPtr RepoCommitTraverseIter -> RepoCommitTraverseIter) -> [AttrOp RepoCommitTraverseIter tag] -> m RepoCommitTraverseIter

newZeroRepoCommitTraverseIter :: MonadIO m => m RepoCommitTraverseIter Source #

Construct a RepoCommitTraverseIter struct initialized to zero.

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.

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 ]

:: (HasCallStack, MonadIO m, IsCancellable a)
=> RepoCommitTraverseIter	`iter`: An iter
-> Maybe a	`cancellable`: Cancellable
-> m RepoCommitIterResult	(Can throw `GError`)