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

Description

Represents a blame.

Synopsis

Exported types

newtype Blame Source #

Memory-managed wrapper type.

Constructors

Blame (ManagedPtr Blame) 

Instances

Instances details
Eq Blame Source # 
Instance details

Defined in GI.Ggit.Objects.Blame

Methods

(==) :: Blame -> Blame -> Bool #

(/=) :: Blame -> Blame -> Bool #

IsGValue Blame Source #

Convert Blame to and from GValue with toGValue and fromGValue.

Instance details

Defined in GI.Ggit.Objects.Blame

GObject Blame Source # 
Instance details

Defined in GI.Ggit.Objects.Blame

Methods

gobjectType :: IO GType #

HasParentTypes Blame Source # 
Instance details

Defined in GI.Ggit.Objects.Blame

type ParentTypes Blame Source # 
Instance details

Defined in GI.Ggit.Objects.Blame

class (GObject o, IsDescendantOf Blame o) => IsBlame o Source #

Type class for types which can be safely cast to Blame, for instance with toBlame.

Instances

Instances details
(GObject o, IsDescendantOf Blame o) => IsBlame o Source # 
Instance details

Defined in GI.Ggit.Objects.Blame

toBlame :: (MonadIO m, IsBlame o) => o -> m Blame Source #

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

noBlame :: Maybe Blame Source #

A convenience alias for Nothing :: Maybe Blame.

Methods

Overloaded methods

fromBuffer

blameFromBuffer Source #

Arguments

:: (HasCallStack, MonadIO m, IsBlame a) 
=> a

blame: a Blame.

-> ByteString

buffer: the contents of the file.

-> m (Maybe Blame)

Returns: a Blame or Nothing. (Can throw GError)

Get blame data for a file that has been modified in memory. blame is a pre-calculated blame for the in-odb history of the file. This means that once a file blame is completed (which can be expensitve), updating the buffer blame is very fast.

Lines that differ between the buffer and the committed version are marked as having a zero id for their ggit_blame_hunk_get_final_commit_id.

getFlags

blameGetFlags Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> BlameOptions

blameOptions: a BlameOptions.

-> m [BlameFlags]

Returns: a BlameFlags.

Get the blame options flags.

getHunkByIndex

blameGetHunkByIndex :: (HasCallStack, MonadIO m, IsBlame a) => a -> Word32 -> m BlameHunk Source #

No description available in the introspection data.

getHunkByLine

blameGetHunkByLine :: (HasCallStack, MonadIO m, IsBlame a) => a -> Word32 -> m BlameHunk Source #

No description available in the introspection data.

getHunkCount

blameGetHunkCount :: (HasCallStack, MonadIO m, IsBlame a) => a -> m Word32 Source #

No description available in the introspection data.

setFlags

blameSetFlags Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> BlameOptions

blameOptions: a BlameOptions.

-> [BlameFlags]

flags: a BlameFlags.

-> m () 

Set the blame options flags.