GI.Ggit.Structs.BlameOptions

Represents blame options.

Exported types

newtype BlameOptions

Memory-managed wrapper type.

Constructors

BlameOptions (ManagedPtr BlameOptions)

Instances

Eq BlameOptions

Defined in GI.Ggit.Structs.BlameOptions

Methods

(==) :: BlameOptions -> BlameOptions -> Bool

(/=) :: BlameOptions -> BlameOptions -> Bool

GBoxed BlameOptions

Defined in GI.Ggit.Structs.BlameOptions

ManagedPtrNewtype BlameOptions

Defined in GI.Ggit.Structs.BlameOptions

Methods

toManagedPtr :: BlameOptions -> ManagedPtr BlameOptions

TypedObject BlameOptions

Defined in GI.Ggit.Structs.BlameOptions

Methods

glibType :: IO GType

HasParentTypes BlameOptions

Defined in GI.Ggit.Structs.BlameOptions

IsGValue (Maybe BlameOptions)

Convert BlameOptions to and from GValue. See toGValue and fromGValue.

Defined in GI.Ggit.Structs.BlameOptions

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe BlameOptions -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe BlameOptions)

type ParentTypes BlameOptions

Defined in GI.Ggit.Structs.BlameOptions

type ParentTypes BlameOptions = '[] :: [Type]

Methods

Click to display all available methods, including inherited ones

Methods

copy, free.

Getters

getMaximumLine, getMinimumLine, getMinimumMatchCharacters, getNewestCommit, getOldestCommit.

Setters

setMaximumLine, setMinimumLine, setMinimumMatchCharacters, setNewestCommit, setOldestCommit.

copy

blameOptionsCopy

Arguments

:: (HasCallStack, MonadIO m)

=> BlameOptions

blameOptions: a BlameOptions.

-> m (Maybe BlameOptions)

Returns: a newly allocated BlameOptions or Nothing.

Copies blameOptions into a newly allocated BlameOptions.

free

blameOptionsFree

Arguments

:: (HasCallStack, MonadIO m)

=> BlameOptions

blameOptions: a BlameOptions.

-> m ()

Frees blameOptions.

getMaximumLine

blameOptionsGetMaximumLine

Arguments

:: (HasCallStack, MonadIO m)

=> BlameOptions

blameOptions: a BlameOptions.

-> m Word32

Returns: the last line to consider.

Get the last line in the file to consider. The default is 1.

getMinimumLine

blameOptionsGetMinimumLine

Arguments

:: (HasCallStack, MonadIO m)

=> BlameOptions

blameOptions: a BlameOptions.

-> m Word32

Returns: the first line to consider.

Get the first line in the file to consider. The default is 1.

getMinimumMatchCharacters

blameOptionsGetMinimumMatchCharacters

Arguments

:: (HasCallStack, MonadIO m)

=> BlameOptions

blameOptions: a BlameOptions.

-> m Word16

Returns: the minimum number of characters.

Get the minimum number of characters that must be detected as moving/copying within a file for it to associate those lines with a parent commit. This is only used when any of the GGIT_BLAME_TRACK_COPIES_SAME_FILE flag is specified. The default value is 20.

getNewestCommit

blameOptionsGetNewestCommit

Arguments

:: (HasCallStack, MonadIO m)

=> BlameOptions

blameOptions: a BlameOptions.

-> m (Maybe OId)

Returns: a OId or Nothing.

Get the id of the newest commit to consider in the blame. The default value of Nothing indicates to use HEAD.

getOldestCommit

blameOptionsGetOldestCommit

Arguments

:: (HasCallStack, MonadIO m)

=> BlameOptions

blameOptions: a BlameOptions.

-> m (Maybe OId)

Returns: a OId or Nothing.

Get the id of the oldest commit to consider in the blame. Teh default value of Nothing indicates to used HEAD.

new

blameOptionsNew

Arguments

:: (HasCallStack, MonadIO m)

=> m BlameOptions

Returns: a newly allocated BlameOptions.

Create a new, empty BlameOptions.

setMaximumLine

blameOptionsSetMaximumLine

Arguments

:: (HasCallStack, MonadIO m)

=> BlameOptions

blameOptions: a BlameOptions.

-> Word32

line: the last line to consider.

-> m ()

Set the last line in the file to consider. Lines start at 1.

setMinimumLine

blameOptionsSetMinimumLine

Arguments

:: (HasCallStack, MonadIO m)

=> BlameOptions

blameOptions: a BlameOptions.

-> Word32

line: the first line to consider.

-> m ()

Set the first line in the file to consider. Lines start at 1.

setMinimumMatchCharacters

blameOptionsSetMinimumMatchCharacters

Arguments

:: (HasCallStack, MonadIO m)

=> BlameOptions

blameOptions: a BlameOptions.

-> Word16

characters: the minimum number of characters.

-> m ()

Set the minimum number of characters that must be detected as moving/copying within a file for it to associate those lines with a parent commit. This is only used when any of the GGIT_BLAME_TRACK_COPIES_ flags are specified. The default value is 20.

setNewestCommit

blameOptionsSetNewestCommit

Arguments

:: (HasCallStack, MonadIO m)

=> BlameOptions

blameOptions: a BlameOptions.

-> Maybe OId

oid: a OId or Nothing.

-> m ()

Set the id of the newest commit to consider in the blame. Specify Nothing to set the default value which indicates to use HEAD.

setOldestCommit

blameOptionsSetOldestCommit

Arguments

:: (HasCallStack, MonadIO m)

=> BlameOptions

blameOptions: a BlameOptions.

-> Maybe OId

oid: a OId.

-> m ()

Set the id of the oldest commit to consider in the blame. Specify Nothing to set the default value which indicates to consider the first commit without a parent.