gi-ggit-1.0.8: libgit2-glib bindings

CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellNone
LanguageHaskell2010

GI.Ggit.Structs.BlameOptions

Contents

Description

Represents blame options.

Synopsis

Exported types

newtype BlameOptions Source #

Memory-managed wrapper type.

Constructors

BlameOptions (ManagedPtr BlameOptions) 
Instances
Eq BlameOptions Source # 
Instance details

Defined in GI.Ggit.Structs.BlameOptions

Methods

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

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

BoxedObject BlameOptions Source # 
Instance details

Defined in GI.Ggit.Structs.BlameOptions

Methods

boxedType :: BlameOptions -> IO GType

IsGValue BlameOptions Source #

Convert BlameOptions to and from GValue with toGValue and fromGValue.

Instance details

Defined in GI.Ggit.Structs.BlameOptions

Methods

toGValue :: BlameOptions -> IO GValue

fromGValue :: GValue -> IO BlameOptions

noBlameOptions :: Maybe BlameOptions Source #

A convenience alias for Nothing :: Maybe BlameOptions.

Methods

Overloaded methods

copy

blameOptionsCopy Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> BlameOptions

blameOptions: a tBlameOptions.

-> m (Maybe BlameOptions)

Returns: a newly allocated tBlameOptions or Nothing.

Copies blameOptions into a newly allocated tBlameOptions.

free

blameOptionsFree Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> BlameOptions

blameOptions: a tBlameOptions.

-> m () 

Frees blameOptions.

getMaximumLine

blameOptionsGetMaximumLine Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> BlameOptions

blameOptions: a tBlameOptions.

-> m Word32

Returns: the last line to consider.

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

getMinimumLine

blameOptionsGetMinimumLine Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> BlameOptions

blameOptions: a tBlameOptions.

-> m Word32

Returns: the first line to consider.

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

getMinimumMatchCharacters

blameOptionsGetMinimumMatchCharacters Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> BlameOptions

blameOptions: a tBlameOptions.

-> 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 Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> BlameOptions

blameOptions: a tBlameOptions.

-> m (Maybe OId)

Returns: a tOId 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 Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> BlameOptions

blameOptions: a tBlameOptions.

-> m (Maybe OId)

Returns: a tOId 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 Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> m BlameOptions

Returns: a newly allocated tBlameOptions.

Create a new, empty tBlameOptions.

setMaximumLine

blameOptionsSetMaximumLine Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> BlameOptions

blameOptions: a tBlameOptions.

-> Word32

line: the last line to consider.

-> m () 

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

setMinimumLine

blameOptionsSetMinimumLine Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> BlameOptions

blameOptions: a tBlameOptions.

-> Word32

line: the first line to consider.

-> m () 

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

setMinimumMatchCharacters

blameOptionsSetMinimumMatchCharacters Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> BlameOptions

blameOptions: a tBlameOptions.

-> 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 Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> BlameOptions

blameOptions: a tBlameOptions.

-> Maybe OId

oid: a tOId 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 Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> BlameOptions

blameOptions: a tBlameOptions.

-> Maybe OId

oid: a tOId.

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