GI.Ggit.Objects.DiffOptions

Represents the options used when creating a Diff.

Exported types

newtype DiffOptions

Memory-managed wrapper type.

Constructors

DiffOptions (ManagedPtr DiffOptions)

Instances

GObject DiffOptions

Defined in GI.Ggit.Objects.DiffOptions

Methods

gobjectType :: IO GType

HasParentTypes DiffOptions

Defined in GI.Ggit.Objects.DiffOptions

type ParentTypes DiffOptions

Defined in GI.Ggit.Objects.DiffOptions

type ParentTypes DiffOptions = Object ': ([] :: [Type])

class (GObject o, IsDescendantOf DiffOptions o) => IsDiffOptions o

Type class for types which can be safely cast to DiffOptions, for instance with toDiffOptions.

Instances

(GObject o, IsDescendantOf DiffOptions o) => IsDiffOptions o

Defined in GI.Ggit.Objects.DiffOptions

toDiffOptions :: (MonadIO m, IsDiffOptions o) => o -> m DiffOptions

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

noDiffOptions :: Maybe DiffOptions

A convenience alias for Nothing :: Maybe DiffOptions.

Methods

getFlags

diffOptionsGetFlags

Arguments

:: (HasCallStack, MonadIO m, IsDiffOptions a)

=> a

options: a DiffOptions.

-> m [DiffOption]

Returns: a DiffOption.

Get the diff flags.

getNContextLines

diffOptionsGetNContextLines

Arguments

:: (HasCallStack, MonadIO m, IsDiffOptions a)

=> a

options: a DiffOptions.

-> m Int32

Returns: the number of context lines.

Get the number of context lines to include in the diff.

getNInterhunkLines

diffOptionsGetNInterhunkLines

Arguments

:: (HasCallStack, MonadIO m, IsDiffOptions a)

=> a

options: a DiffOptions.

-> m Int32

Returns: the number of lines.

Get the number of interhunk lines to include in the diff.

getNewPrefix

diffOptionsGetNewPrefix

Arguments

:: (HasCallStack, MonadIO m, IsDiffOptions a)

=> a

options: a DiffOptions.

-> m (Maybe Text)

Returns: the new-prefix string or Nothing.

Get the diff new-prefix string.

getOldPrefix

diffOptionsGetOldPrefix

Arguments

:: (HasCallStack, MonadIO m, IsDiffOptions a)

=> a

options: a DiffOptions.

-> m (Maybe Text)

Returns: the old-prefix string or Nothing.

Get the diff old-prefix string.

getPathspec

diffOptionsGetPathspec

Arguments

:: (HasCallStack, MonadIO m, IsDiffOptions a)

=> a

options: a DiffOptions.

-> m (Maybe [Text])

Returns: the pathspec or Nothing.

Get the pathspec.

new

diffOptionsNew

Arguments

:: (HasCallStack, MonadIO m)

=> m (Maybe DiffOptions)

Returns: a DiffOptions or Nothing.

Create a new diff options object.

setFlags

diffOptionsSetFlags

Arguments

:: (HasCallStack, MonadIO m, IsDiffOptions a)

=> a

options: a DiffOptions.

-> [DiffOption]

flags: a DiffOption.

-> m ()

Set the diff flags.

setNContextLines

diffOptionsSetNContextLines

Arguments

:: (HasCallStack, MonadIO m, IsDiffOptions a)

=> a

options: a DiffOptions.

-> Int32

n: the number of lines.

-> m ()

Set the number of context lines to include in the diff.

setNInterhunkLines

diffOptionsSetNInterhunkLines

Arguments

:: (HasCallStack, MonadIO m, IsDiffOptions a)

=> a

options: a DiffOptions.

-> Int32

n: the number of lines.

-> m ()

Set the number of interhunk lines to include in the diff.

setNewPrefix

diffOptionsSetNewPrefix

Arguments

:: (HasCallStack, MonadIO m, IsDiffOptions a)

=> a

options: a DiffOptions.

-> Text

prefix: the prefix.

-> m ()

Set the diff new-prefix string.

setOldPrefix

diffOptionsSetOldPrefix

Arguments

:: (HasCallStack, MonadIO m, IsDiffOptions a)

=> a

options: a DiffOptions.

-> Text

prefix: the prefix.

-> m ()

Get the diff old-prefix string.

setPathspec

diffOptionsSetPathspec

Arguments

:: (HasCallStack, MonadIO m, IsDiffOptions a)

=> a

options: a DiffOptions.

-> Maybe [Text]

pathspec: the pathspec.

-> m ()

Set the pathspec.

Properties

flags

The diff option flags.

constructDiffOptionsFlags :: IsDiffOptions o => [DiffOption] -> IO (GValueConstruct o)

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

getDiffOptionsFlags :: (MonadIO m, IsDiffOptions o) => o -> m [DiffOption]

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

get diffOptions #flags

setDiffOptionsFlags :: (MonadIO m, IsDiffOptions o) => o -> [DiffOption] -> m ()

Set the value of the “flags” property. When overloading is enabled, this is equivalent to

set diffOptions [ #flags := value ]

nContextLines

No description available in the introspection data.

constructDiffOptionsNContextLines :: IsDiffOptions o => Int32 -> IO (GValueConstruct o)

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

getDiffOptionsNContextLines :: (MonadIO m, IsDiffOptions o) => o -> m Int32

Get the value of the “n-context-lines” property. When overloading is enabled, this is equivalent to

get diffOptions #nContextLines

setDiffOptionsNContextLines :: (MonadIO m, IsDiffOptions o) => o -> Int32 -> m ()

Set the value of the “n-context-lines” property. When overloading is enabled, this is equivalent to

set diffOptions [ #nContextLines := value ]

nInterhunkLines

No description available in the introspection data.

constructDiffOptionsNInterhunkLines :: IsDiffOptions o => Int32 -> IO (GValueConstruct o)

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

getDiffOptionsNInterhunkLines :: (MonadIO m, IsDiffOptions o) => o -> m Int32

Get the value of the “n-interhunk-lines” property. When overloading is enabled, this is equivalent to

get diffOptions #nInterhunkLines

setDiffOptionsNInterhunkLines :: (MonadIO m, IsDiffOptions o) => o -> Int32 -> m ()

Set the value of the “n-interhunk-lines” property. When overloading is enabled, this is equivalent to

set diffOptions [ #nInterhunkLines := value ]

newPrefix

No description available in the introspection data.

constructDiffOptionsNewPrefix :: IsDiffOptions o => Text -> IO (GValueConstruct o)

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

getDiffOptionsNewPrefix :: (MonadIO m, IsDiffOptions o) => o -> m (Maybe Text)

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

get diffOptions #newPrefix

setDiffOptionsNewPrefix :: (MonadIO m, IsDiffOptions o) => o -> Text -> m ()

Set the value of the “new-prefix” property. When overloading is enabled, this is equivalent to

set diffOptions [ #newPrefix := value ]

oldPrefix

No description available in the introspection data.

constructDiffOptionsOldPrefix :: IsDiffOptions o => Text -> IO (GValueConstruct o)

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

getDiffOptionsOldPrefix :: (MonadIO m, IsDiffOptions o) => o -> m (Maybe Text)

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

get diffOptions #oldPrefix

setDiffOptionsOldPrefix :: (MonadIO m, IsDiffOptions o) => o -> Text -> m ()

Set the value of the “old-prefix” property. When overloading is enabled, this is equivalent to

set diffOptions [ #oldPrefix := value ]

pathspec

No description available in the introspection data.

clearDiffOptionsPathspec :: (MonadIO m, IsDiffOptions o) => o -> m ()

Set the value of the “pathspec” property to Nothing. When overloading is enabled, this is equivalent to

clear #pathspec

constructDiffOptionsPathspec :: IsDiffOptions o => [Text] -> IO (GValueConstruct o)

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

getDiffOptionsPathspec :: (MonadIO m, IsDiffOptions o) => o -> m (Maybe [Text])

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

get diffOptions #pathspec

setDiffOptionsPathspec :: (MonadIO m, IsDiffOptions o) => o -> [Text] -> m ()

Set the value of the “pathspec” property. When overloading is enabled, this is equivalent to

set diffOptions [ #pathspec := value ]