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.Ggit.Structs.TreeEntry

Contents

Exported types
Methods

Description

Represents an entry in a tree.

Synopsis

newtype TreeEntry = TreeEntry (ManagedPtr TreeEntry)
treeEntryGetFileMode :: (HasCallStack, MonadIO m) => TreeEntry -> m FileMode
treeEntryGetId :: (HasCallStack, MonadIO m) => TreeEntry -> m (Maybe OId)
treeEntryGetName :: (HasCallStack, MonadIO m) => TreeEntry -> m (Maybe Text)
treeEntryGetObjectType :: (HasCallStack, MonadIO m) => TreeEntry -> m GType
treeEntryRef :: (HasCallStack, MonadIO m) => TreeEntry -> m (Maybe TreeEntry)
treeEntryUnref :: (HasCallStack, MonadIO m) => TreeEntry -> m ()

Exported types

newtype TreeEntry Source #

Memory-managed wrapper type.

Constructors

TreeEntry (ManagedPtr TreeEntry)

Instances

Instances details

Eq TreeEntry Source #
Instance details Defined in GI.Ggit.Structs.TreeEntry Methods (==) :: TreeEntry -> TreeEntry -> Bool # (/=) :: TreeEntry -> TreeEntry -> Bool #
GBoxed TreeEntry Source #
Instance details Defined in GI.Ggit.Structs.TreeEntry
ManagedPtrNewtype TreeEntry Source #
Instance details Defined in GI.Ggit.Structs.TreeEntry Methods toManagedPtr :: TreeEntry -> ManagedPtr TreeEntry
TypedObject TreeEntry Source #
Instance details Defined in GI.Ggit.Structs.TreeEntry Methods glibType :: IO GType
HasParentTypes TreeEntry Source #
Instance details Defined in GI.Ggit.Structs.TreeEntry
IsGValue (Maybe TreeEntry) Source #	Convert `TreeEntry` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details Defined in GI.Ggit.Structs.TreeEntry Methods gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe TreeEntry -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe TreeEntry)
type ParentTypes TreeEntry Source #
Instance details Defined in GI.Ggit.Structs.TreeEntry type ParentTypes TreeEntry = '[] :: [Type]

Methods

Click to display all available methods, including inherited ones

Expand

Methods

ref, unref.

Getters

getFileMode, getId, getName, getObjectType.

Setters

None.

getFileMode

treeEntryGetFileMode Source #

Arguments

:: (HasCallStack, MonadIO m)
=> TreeEntry	`entry`: a `TreeEntry`.
-> m FileMode	Returns: the `FileMode` of a tree entry.

Gets the FileMode of a tree entry.

getId

treeEntryGetId Source #

Arguments

:: (HasCallStack, MonadIO m)
=> TreeEntry	`entry`: a `TreeEntry`.
-> m (Maybe OId)	Returns: a `OId` or `Nothing`.

Get the OId of the entry.

getName

treeEntryGetName Source #

Arguments

:: (HasCallStack, MonadIO m)
=> TreeEntry	`entry`: a `TreeEntry`.
-> m (Maybe Text)	Returns: the name of the tree entry or `Nothing`.

Get the name of the tree entry.

getObjectType

treeEntryGetObjectType Source #

Arguments

:: (HasCallStack, MonadIO m)
=> TreeEntry	`entry`: a `TreeEntry`.
-> m GType	Returns: a `GType`.

Get the type of the tree entry object.

ref

treeEntryRef Source #

Arguments

:: (HasCallStack, MonadIO m)
=> TreeEntry	`entry`: a `TreeEntry`.
-> m (Maybe TreeEntry)	Returns: a `TreeEntry` or `Nothing`.

Atomically increments the reference count of entry by one. This function is MT-safe and may be called from any thread.

unref

treeEntryUnref Source #

Arguments

:: (HasCallStack, MonadIO m)
=> TreeEntry	`entry`: a `TreeEntry`.
-> m ()

Atomically decrements the reference count of entry by one. If the reference count drops to 0, entry is freed.