Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria (inaki@blueleaf.cc) |
Safe Haskell | None |
Language | Haskell2010 |
Represents a tree object.
Synopsis
- newtype TreeBuilder = TreeBuilder (ManagedPtr TreeBuilder)
- class (GObject o, IsDescendantOf TreeBuilder o) => IsTreeBuilder o
- toTreeBuilder :: (MonadIO m, IsTreeBuilder o) => o -> m TreeBuilder
- noTreeBuilder :: Maybe TreeBuilder
- treeBuilderClear :: (HasCallStack, MonadIO m, IsTreeBuilder a) => a -> m ()
- treeBuilderGetEntry :: (HasCallStack, MonadIO m, IsTreeBuilder a) => a -> Text -> m (Maybe TreeEntry)
- treeBuilderInsert :: (HasCallStack, MonadIO m, IsTreeBuilder a) => a -> Text -> OId -> FileMode -> m (Maybe TreeEntry)
- treeBuilderRemove :: (HasCallStack, MonadIO m, IsTreeBuilder a) => a -> Text -> m ()
- treeBuilderWrite :: (HasCallStack, MonadIO m, IsTreeBuilder a) => a -> m (Maybe OId)
Exported types
newtype TreeBuilder Source #
Memory-managed wrapper type.
Instances
GObject TreeBuilder Source # | |
Defined in GI.Ggit.Objects.TreeBuilder gobjectType :: IO GType # | |
HasParentTypes TreeBuilder Source # | |
Defined in GI.Ggit.Objects.TreeBuilder | |
type ParentTypes TreeBuilder Source # | |
Defined in GI.Ggit.Objects.TreeBuilder |
class (GObject o, IsDescendantOf TreeBuilder o) => IsTreeBuilder o Source #
Type class for types which can be safely cast to TreeBuilder
, for instance with toTreeBuilder
.
Instances
(GObject o, IsDescendantOf TreeBuilder o) => IsTreeBuilder o Source # | |
Defined in GI.Ggit.Objects.TreeBuilder |
toTreeBuilder :: (MonadIO m, IsTreeBuilder o) => o -> m TreeBuilder Source #
Cast to TreeBuilder
, for types for which this is known to be safe. For general casts, use castTo
.
noTreeBuilder :: Maybe TreeBuilder Source #
A convenience alias for Nothing
:: Maybe
TreeBuilder
.
Methods
clear
:: (HasCallStack, MonadIO m, IsTreeBuilder a) | |
=> a |
|
-> m () |
Clear all entries in the tree builder.
getEntry
:: (HasCallStack, MonadIO m, IsTreeBuilder a) | |
=> a |
|
-> Text |
|
-> m (Maybe TreeEntry) | Returns: the |
Get an entry by path.
insert
:: (HasCallStack, MonadIO m, IsTreeBuilder a) | |
=> a |
|
-> Text |
|
-> OId |
|
-> FileMode |
|
-> m (Maybe TreeEntry) |
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
:: (HasCallStack, MonadIO m, IsTreeBuilder a) | |
=> a |
|
-> Text |
|
-> m () | (Can throw |
Remove an entry from the builder by path.
write
:: (HasCallStack, MonadIO m, IsTreeBuilder a) | |
=> a |
|
-> m (Maybe OId) | Returns: the |
Write the contents of the tree builder as a tree object.