GI.Ggit.Objects.Tree

Represents a tree object.

Exported types

newtype Tree

Constructors

Tree (ManagedPtr Tree)

Instances

GObject Tree

Methods

gobjectType :: Tree -> IO GType

IsObject Tree

IsTree Tree

IsObjectFactoryBase Tree

IsObject Tree

IsNative Tree

class GObject o => IsTree o

Instances

(GObject a, UnknownAncestorError Constraint Tree a) => IsTree a

IsTree Tree

toTree :: (MonadIO m, IsTree o) => o -> m Tree

noTree :: Maybe Tree

Methods

get

treeGet

Arguments

:: (HasCallStack, MonadIO m, IsTree a)

=> a

tree: a Tree.

-> Word32

i: the index of the entry.

-> m TreeEntry

Returns: a TreeEntry.

Get a tree entry by index.

getByName

treeGetByName

Arguments

:: (HasCallStack, MonadIO m, IsTree a)

=> a

tree: a Tree.

-> Text

name: a filename.

-> m TreeEntry

Returns: a TreeEntry.

Get a tree entry by name.

getByPath

treeGetByPath

Arguments

:: (HasCallStack, MonadIO m, IsTree a)

=> a

tree: a Tree.

-> Text

path: a path.

-> m TreeEntry

Returns: a TreeEntry. (Can throw GError)

Retrieves a tree entry contained in a tree or in any of its subtrees, given its relative path.

getId

treeGetId

Arguments

:: (HasCallStack, MonadIO m, IsTree a)

=> a

tree: a Tree.

-> m OId

Returns: a OId.

Get the OId of the tree.

size

treeSize

Arguments

:: (HasCallStack, MonadIO m, IsTree a)

=> a

tree: a Tree.

-> m Word32

Returns: the number of entries in the tree.

Get the number of entries in the tree.

walk

treeWalk

Arguments

:: (HasCallStack, MonadIO m, IsTree a)

=> a

tree: a Tree.

-> TreeWalkMode

mode: the walking order.

-> TreeWalkCallback

callback: the callback to call for each entry.

-> m ()

(Can throw GError)

Walk all the entries of a tree object recursively (resolving and walking subtrees of the tree as needed). The error will be set to the error returned by callback (if any).