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

Contents

Exported types
Methods

Description

Represents a diff binary file.

Synopsis

newtype DiffBinaryFile = DiffBinaryFile (ManagedPtr DiffBinaryFile)
diffBinaryFileGetBinaryType :: (HasCallStack, MonadIO m) => DiffBinaryFile -> m DiffBinaryType
diffBinaryFileGetData :: (HasCallStack, MonadIO m) => DiffBinaryFile -> Word64 -> m Word8
diffBinaryFileGetInflatedSize :: (HasCallStack, MonadIO m) => DiffBinaryFile -> m Word64
diffBinaryFileRef :: (HasCallStack, MonadIO m) => DiffBinaryFile -> m DiffBinaryFile
diffBinaryFileUnref :: (HasCallStack, MonadIO m) => DiffBinaryFile -> m ()

Exported types

newtype DiffBinaryFile Source #

Memory-managed wrapper type.

Constructors

DiffBinaryFile (ManagedPtr DiffBinaryFile)

Instances

Instances details

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

Methods

Click to display all available methods, including inherited ones

Expand

Methods

ref, unref.

Getters

getBinaryType, getData, getInflatedSize.

Setters

None.

getBinaryType

diffBinaryFileGetBinaryType Source #

Arguments

:: (HasCallStack, MonadIO m)
=> DiffBinaryFile	`file`: a `DiffBinaryFile`.
-> m DiffBinaryType	Returns: the file's binary type.

Gets the DiffBinaryType for file.

getData

diffBinaryFileGetData Source #

Arguments

:: (HasCallStack, MonadIO m)
=> DiffBinaryFile	`file`: a `DiffBinaryFile`.
-> Word64	`size`: location to return size of byte data.
-> m Word8	Returns: a pointer to the binary data, or `Nothing`.

Get the binary data. This data should not be modified.

getInflatedSize

diffBinaryFileGetInflatedSize Source #

Arguments

:: (HasCallStack, MonadIO m)
=> DiffBinaryFile	`file`: a `DiffBinaryFile`.
-> m Word64	Returns: the length of the binary data after inflation.

Gets the length of the binary data after inflation.

ref

diffBinaryFileRef Source #

Arguments

:: (HasCallStack, MonadIO m)
=> DiffBinaryFile	`file`: a `Diff`.
-> m DiffBinaryFile	Returns: a `DiffBinaryFile`.

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

unref

diffBinaryFileUnref Source #

Arguments

:: (HasCallStack, MonadIO m)
=> DiffBinaryFile	`file`: a `DiffBinaryFile`.
-> m ()

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