GI.Ggit.Objects.TreeBuilder

Represents a tree object.

Exported types

newtype TreeBuilder

Memory-managed wrapper type.

Constructors

TreeBuilder (ManagedPtr TreeBuilder)

Instances

Eq TreeBuilder

Defined in GI.Ggit.Objects.TreeBuilder

Methods

(==) :: TreeBuilder -> TreeBuilder -> Bool

(/=) :: TreeBuilder -> TreeBuilder -> Bool

GObject TreeBuilder

Defined in GI.Ggit.Objects.TreeBuilder

ManagedPtrNewtype TreeBuilder

Defined in GI.Ggit.Objects.TreeBuilder

Methods

toManagedPtr :: TreeBuilder -> ManagedPtr TreeBuilder

TypedObject TreeBuilder

Defined in GI.Ggit.Objects.TreeBuilder

Methods

glibType :: IO GType

HasParentTypes TreeBuilder

Defined in GI.Ggit.Objects.TreeBuilder

IsGValue (Maybe TreeBuilder)

Convert TreeBuilder to and from GValue. See toGValue and fromGValue.

Defined in GI.Ggit.Objects.TreeBuilder

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe TreeBuilder -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe TreeBuilder)

type ParentTypes TreeBuilder

Defined in GI.Ggit.Objects.TreeBuilder

type ParentTypes TreeBuilder = '[Native, ObjectFactoryBase, Object]

class (GObject o, IsDescendantOf TreeBuilder o) => IsTreeBuilder o

Type class for types which can be safely cast to TreeBuilder, for instance with toTreeBuilder.

Instances

(GObject o, IsDescendantOf TreeBuilder o) => IsTreeBuilder o

Defined in GI.Ggit.Objects.TreeBuilder

toTreeBuilder :: (MonadIO m, IsTreeBuilder o) => o -> m TreeBuilder

Cast to TreeBuilder, for types for which this is known to be safe. For general casts, use castTo.

Methods

Click to display all available methods, including inherited ones

Methods

bindProperty, bindPropertyFull, clear, forceFloating, freezeNotify, getv, insert, isFloating, notify, notifyByPspec, ref, refSink, remove, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure, write.

Getters

getData, getEntry, getProperty, getQdata.

Setters

setData, setDataFull, setProperty.

clear

treeBuilderClear

Arguments

:: (HasCallStack, MonadIO m, IsTreeBuilder a)

=> a

builder: a TreeBuilder.

-> m ()

Clear all entries in the tree builder.

getEntry

treeBuilderGetEntry

Arguments

:: (HasCallStack, MonadIO m, IsTreeBuilder a)

=> a

builder: a TreeBuilder.

-> Text

path: the path to remove.

-> m (Maybe TreeEntry)

Returns: the GGitTreeEntry or Nothing if no such entry exists.

Get an entry by path.

insert

treeBuilderInsert

Arguments

:: (HasCallStack, MonadIO m, IsTreeBuilder a)

=> a

builder: a TreeBuilder.

-> Text

filename: the file name.

-> OId

oid: the OId of the file blob to insert.

-> FileMode

fileMode: a FileMode.

-> m (Maybe TreeEntry)

Returns: a TreeEntry or Nothing. (Can throw GError)

Insert a file with a given blob in the tree builder. If the tree builder already contains an entry for the given file, then this entry will be overwritten.

Note that the returned TreeEntry is bound to the lifetime of the tree builder and cannot be used after the tree builder has been freed.

remove

treeBuilderRemove

Arguments

:: (HasCallStack, MonadIO m, IsTreeBuilder a)

=> a

builder: a TreeBuilder.

-> Text

path: the path to remove.

-> m ()

(Can throw GError)

Remove an entry from the builder by path.

write

treeBuilderWrite

Arguments

:: (HasCallStack, MonadIO m, IsTreeBuilder a)

=> a

builder: a TreeBuilder.

-> m (Maybe OId)

Returns: the OId of the created tree object or Nothing. (Can throw GError)

Write the contents of the tree builder as a tree object.