GI.Ggit.Objects.Diff

Represents a diff list.

Exported types

newtype Diff

Memory-managed wrapper type.

Constructors

Diff (ManagedPtr Diff)

Instances

GObject Diff

Defined in GI.Ggit.Objects.Diff

Methods

gobjectType :: Diff -> IO GType

IsObject Diff

Defined in GI.Ggit.Objects.Diff

IsDiff Diff

Defined in GI.Ggit.Objects.Diff

IsNative Diff

Defined in GI.Ggit.Objects.Diff

IsObjectFactoryBase Diff

Defined in GI.Ggit.Objects.Diff

class GObject o => IsDiff o

Type class for types which can be safely cast to Diff, for instance with toDiff.

Instances

(GObject a, (UnknownAncestorError Diff a :: Constraint)) => IsDiff a

Defined in GI.Ggit.Objects.Diff

IsDiff Diff

Defined in GI.Ggit.Objects.Diff

toDiff :: (MonadIO m, IsDiff o) => o -> m Diff

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

noDiff :: Maybe Diff

A convenience alias for Nothing :: Maybe Diff.

Methods

findSimilar

diffFindSimilar

Arguments

:: (HasCallStack, MonadIO m, IsDiff a, IsDiffFindOptions b)

=> a

diff: a Diff.

-> Maybe b

options: a DiffFindOptions or Nothing.

-> m ()

(Can throw GError)

Transform diff marking file renames, copies, etc.. If options is set to Nothing, then the default options will be used.

formatEmail

diffFormatEmail

Arguments

:: (HasCallStack, MonadIO m, IsDiff a, IsDiffFormatEmailOptions b)

=> a

diff: a Diff.

-> b

options: a DiffFormatEmailOptions.

-> m (Maybe Text)

Returns: the patch or Nothing if an error occurred. (Can throw GError)

Create an e-mail ready patch from a diff.

getDelta

diffGetDelta

Arguments

:: (HasCallStack, MonadIO m, IsDiff a)

=> a

diff: a Diff.

-> Word64

index: the index.

-> m (Maybe DiffDelta)

Returns: a DiffDelta or Nothing.

Get the delta at the specified index.

getNumDeltas

diffGetNumDeltas

Arguments

:: (HasCallStack, MonadIO m, IsDiff a)

=> a

diff: a Diff.

-> m Word64

Returns: the number of deltas.

Get the number of deltas in the diff.

merge

diffMerge

Arguments

:: (HasCallStack, MonadIO m, IsDiff a, IsDiff b)

=> a

onto: the Diff to merge into.

-> b

from: the Diff to merge.

-> m ()

(Can throw GError)

Merges from into onto unless error is set.

newIndexToWorkdir

diffNewIndexToWorkdir

Arguments

:: (HasCallStack, MonadIO m, IsRepository a, IsIndex b, IsDiffOptions c)

=> a

repository: a Repository.

-> Maybe b

index: a Index, or Nothing.

-> Maybe c

diffOptions: a DiffOptions, or Nothing.

-> m (Maybe Diff)

Returns: a newly allocated Diff if there was no error, Nothing otherwise. (Can throw GError)

Creates a Diff which compares the working directory and the index.

If index is Nothing then repository index is used. If diffOptions is Nothing then the defaults specified in diffOptionsNew are used.

newTreeToIndex

diffNewTreeToIndex

Arguments

:: (HasCallStack, MonadIO m, IsRepository a, IsTree b, IsIndex c, IsDiffOptions d)

=> a

repository: a Repository.

-> Maybe b

oldTree: a Tree to diff from.

-> Maybe c

index: a Index, or Nothing.

-> Maybe d

diffOptions: a DiffOptions, or Nothing.

-> m (Maybe Diff)

Returns: a newly allocated Diff if there was no error, Nothing otherwise. (Can throw GError)

Creates a Diff which compares oldTree and the index.

If index is Nothing then repository index is used. If diffOptions is Nothing then the defaults specified in diffOptionsNew are used.

newTreeToTree

diffNewTreeToTree

Arguments

:: (HasCallStack, MonadIO m, IsRepository a, IsTree b, IsTree c, IsDiffOptions d)

=> a

repository: a Repository.

-> Maybe b

oldTree: a Tree to diff from.

-> Maybe c

newTree: a Tree to diff to.

-> Maybe d

diffOptions: a DiffOptions, or Nothing.

-> m (Maybe Diff)

Returns: a newly allocated Diff if there was no error, Nothing otherwise. (Can throw GError)

Creates a Diff which compares oldTree and newTree.

If diffOptions is Nothing then the defaults specified in diffOptionsNew are used.

newTreeToWorkdir

diffNewTreeToWorkdir

Arguments

:: (HasCallStack, MonadIO m, IsRepository a, IsTree b, IsDiffOptions c)

=> a

repository: a Repository.

-> Maybe b

oldTree: a Tree to diff from.

-> Maybe c

diffOptions: a DiffOptions, or Nothing.

-> m (Maybe Diff)

Returns: a newly allocated Diff if there was no error, Nothing otherwise. (Can throw GError)

Creates a Diff which compares the working directory and oldTree.

If diffOptions is Nothing then the defaults specified in diffOptionsNew are used.

print

diffPrint

Arguments

:: (HasCallStack, MonadIO m, IsDiff a)

=> a

diff: a Diff.

-> DiffFormatType

type: a DiffFormatType.

-> DiffLineCallback

printCb: a DiffLineCallback.

-> m ()

(Can throw GError)

Iterates over diff generating text output like "git diff".

Properties

repository

No description available in the introspection data.

constructDiffRepository :: (IsDiff o, IsRepository a) => a -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “repository” property. This is rarely needed directly, but it is used by new.

getDiffRepository :: (MonadIO m, IsDiff o) => o -> m (Maybe Repository)

Get the value of the “repository” property. When overloading is enabled, this is equivalent to

get diff #repository