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.TransferProgress

Contents

Exported types
Methods

Description

Represents transfering progress.

Synopsis

newtype TransferProgress = TransferProgress (ManagedPtr TransferProgress)
transferProgressCopy :: (HasCallStack, MonadIO m) => TransferProgress -> m (Maybe TransferProgress)
transferProgressFree :: (HasCallStack, MonadIO m) => TransferProgress -> m ()
transferProgressGetIndexedObjects :: (HasCallStack, MonadIO m) => TransferProgress -> m Word32
transferProgressGetReceivedBytes :: (HasCallStack, MonadIO m) => TransferProgress -> m Word64
transferProgressGetReceivedObjects :: (HasCallStack, MonadIO m) => TransferProgress -> m Word32
transferProgressGetTotalObjects :: (HasCallStack, MonadIO m) => TransferProgress -> m Word32

Exported types

newtype TransferProgress Source #

Memory-managed wrapper type.

Constructors

TransferProgress (ManagedPtr TransferProgress)

Instances

Instances details

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

Methods

Click to display all available methods, including inherited ones

Expand

Methods

copy, free.

Getters

getIndexedObjects, getReceivedBytes, getReceivedObjects, getTotalObjects.

Setters

None.

copy

transferProgressCopy Source #

Arguments

:: (HasCallStack, MonadIO m)
=> TransferProgress	`progress`: a `TransferProgress`.
-> m (Maybe TransferProgress)	Returns: a newly allocated `TransferProgress` or `Nothing`.

Copies progress into a newly allocated TransferProgress.

free

transferProgressFree Source #

Arguments

:: (HasCallStack, MonadIO m)
=> TransferProgress	`progress`: a `TransferProgress`.
-> m ()

Frees progress.

getIndexedObjects

transferProgressGetIndexedObjects Source #

Arguments

:: (HasCallStack, MonadIO m)
=> TransferProgress	`progress`: a `TransferProgress`.
-> m Word32	Returns: the indexed objects of the transfer.

Gets the indexed objects of the transfer.

getReceivedBytes

transferProgressGetReceivedBytes Source #

Arguments

:: (HasCallStack, MonadIO m)
=> TransferProgress	`progress`: a `TransferProgress`.
-> m Word64	Returns: the received bytes of the transfer.

Gets the received bytes of the transfer.

getReceivedObjects

transferProgressGetReceivedObjects Source #

Arguments

:: (HasCallStack, MonadIO m)
=> TransferProgress	`progress`: a `TransferProgress`.
-> m Word32	Returns: the received objects of the transfer.

Gets the received objects of the transfer.

getTotalObjects

transferProgressGetTotalObjects Source #

Arguments

:: (HasCallStack, MonadIO m)
=> TransferProgress	`progress`: a `TransferProgress`.
-> m Word32	Returns: the total objects of the transfer.

Gets the total objects of the transfer.