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

Contents

Description

Represents the options used when reverting.

Synopsis

Exported types

newtype RevertOptions Source #

Memory-managed wrapper type.

Constructors

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

Defined in GI.Ggit.Structs.RevertOptions

BoxedObject RevertOptions Source # 
Instance details

Defined in GI.Ggit.Structs.RevertOptions

Methods

boxedType :: RevertOptions -> IO GType

IsGValue RevertOptions Source #

Convert RevertOptions to and from GValue with toGValue and fromGValue.

Instance details

Defined in GI.Ggit.Structs.RevertOptions

Methods

toGValue :: RevertOptions -> IO GValue

fromGValue :: GValue -> IO RevertOptions

noRevertOptions :: Maybe RevertOptions Source #

A convenience alias for Nothing :: Maybe RevertOptions.

Methods

Overloaded methods

copy

revertOptionsCopy Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> RevertOptions

revertOptions: a tRevertOptions.

-> m (Maybe RevertOptions)

Returns: a newly allocated tRevertOptions or Nothing.

Copies revertOptions into a newly allocated tRevertOptions.

free

revertOptionsFree Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> RevertOptions

revertOptions: a tRevertOptions.

-> m () 

Frees revertOptions.

new

revertOptionsNew Source #

Arguments

:: (HasCallStack, MonadIO m, IsCheckoutOptions a) 
=> Word32

mainline: the mainline.

-> Maybe MergeOptions

mergeOptions: a tMergeOptions.

-> Maybe a

checkoutOptions: a tCheckoutOptions.

-> m (Maybe RevertOptions)

Returns: a tRevertOptions or Nothing.

Create a new tRevertOptions. Note that the passed in mergeOptions and checkoutOptions are copied by this function, and alterations in either after this call are therefore not reflected in the revert options.

The mainline indicates which parent to use for the revert when reverting a merge commit.