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

Contents

Description

Represents the options used when rebasing.

Synopsis

Exported types

newtype RebaseOptions Source #

Memory-managed wrapper type.

Constructors

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

Defined in GI.Ggit.Structs.RebaseOptions

BoxedObject RebaseOptions Source # 
Instance details

Defined in GI.Ggit.Structs.RebaseOptions

Methods

boxedType :: RebaseOptions -> IO GType

IsGValue RebaseOptions Source #

Convert RebaseOptions to and from GValue with toGValue and fromGValue.

Instance details

Defined in GI.Ggit.Structs.RebaseOptions

Methods

toGValue :: RebaseOptions -> IO GValue

fromGValue :: GValue -> IO RebaseOptions

noRebaseOptions :: Maybe RebaseOptions Source #

A convenience alias for Nothing :: Maybe RebaseOptions.

Methods

Overloaded methods

copy

rebaseOptionsCopy Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> RebaseOptions

rebaseOptions: a tRebaseOptions.

-> m (Maybe RebaseOptions)

Returns: a newly allocated tRebaseOptions or Nothing.

Copies rebaseOptions into a newly allocated tRebaseOptions.

free

rebaseOptionsFree Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> RebaseOptions

rebaseOptions: a tRebaseOptions.

-> m () 

Frees rebaseOptions.

getCheckoutOptions

rebaseOptionsGetCheckoutOptions Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> RebaseOptions

rebaseOptions: a tRebaseOptions.

-> m (Maybe CheckoutOptions)

Returns: the checkout options or Nothing.

Get the checkout options object or Nothing if not set.

getQuiet

rebaseOptionsGetQuiet Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> RebaseOptions

rebaseOptions: a tRebaseOptions.

-> m Bool

Returns: returns whether you want a quiet rebase experience.

Gets whether you want a quiet rebase experience.

getRewriteNotesRef

rebaseOptionsGetRewriteNotesRef Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> RebaseOptions

rebaseOptions: a tRebaseOptions.

-> m (Maybe Text)

Returns: the name of the notes reference or Nothing.

Gets the the name of the notes reference used to rewrite notes for rebased commits when finishing the rebase or Nothing if not set.

new

rebaseOptionsNew Source #

Arguments

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

Returns: a newly allocated tRebaseOptions.

Creates a new tRebaseOptions.

setCheckoutOptions

rebaseOptionsSetCheckoutOptions :: (HasCallStack, MonadIO m, IsCheckoutOptions a) => RebaseOptions -> a -> m () Source #

No description available in the introspection data.

setQuiet

rebaseOptionsSetQuiet Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> RebaseOptions

rebaseOptions: a tRebaseOptions.

-> Bool

quiet: whether you want a quiet rebase experience.

-> m () 

Used by ggit_rebase_init(), this will instruct other clients working on this rebase that you want a quiet rebase experience, which they may choose to provide in an application-specific manner. This has no effect upon libgit2-glib directly, but is provided for interoperability between Git tools.

setRewriteNotesRef

rebaseOptionsSetRewriteNotesRef Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> RebaseOptions

rebaseOptions: a tRebaseOptions.

-> Text

rewriteNotesRef: the name of the notes reference.

-> m () 

Used by rebaseFinish, this is the name of the notes reference used to rewrite notes for rebased commits when finishing the rebase; if Nothing, the contents of the configuration option notes.rewriteRef is examined, unless the configuration option notes.rewrite.rebase is set to false. If notes.rewriteRef is also Nothing, notes will not be rewritten.