| Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria |
| Safe Haskell | None |
| Language | Haskell2010 |
GI.Ggit.Structs.RebaseOptions
Description
Represents the options used when rebasing.
Synopsis
- newtype RebaseOptions = RebaseOptions (ManagedPtr RebaseOptions)
- noRebaseOptions :: Maybe RebaseOptions
- rebaseOptionsCopy :: (HasCallStack, MonadIO m) => RebaseOptions -> m (Maybe RebaseOptions)
- rebaseOptionsFree :: (HasCallStack, MonadIO m) => RebaseOptions -> m ()
- rebaseOptionsGetCheckoutOptions :: (HasCallStack, MonadIO m) => RebaseOptions -> m (Maybe CheckoutOptions)
- rebaseOptionsGetQuiet :: (HasCallStack, MonadIO m) => RebaseOptions -> m Bool
- rebaseOptionsGetRewriteNotesRef :: (HasCallStack, MonadIO m) => RebaseOptions -> m (Maybe Text)
- rebaseOptionsNew :: (HasCallStack, MonadIO m) => m RebaseOptions
- rebaseOptionsSetCheckoutOptions :: (HasCallStack, MonadIO m, IsCheckoutOptions a) => RebaseOptions -> a -> m ()
- rebaseOptionsSetQuiet :: (HasCallStack, MonadIO m) => RebaseOptions -> Bool -> m ()
- rebaseOptionsSetRewriteNotesRef :: (HasCallStack, MonadIO m) => RebaseOptions -> Text -> m ()
Exported types
newtype RebaseOptions Source #
Memory-managed wrapper type.
Constructors
| RebaseOptions (ManagedPtr RebaseOptions) |
Instances
| Eq RebaseOptions Source # | |
Defined in GI.Ggit.Structs.RebaseOptions Methods (==) :: RebaseOptions -> RebaseOptions -> Bool # (/=) :: RebaseOptions -> RebaseOptions -> Bool # | |
| IsGValue RebaseOptions Source # | Convert |
Defined in GI.Ggit.Structs.RebaseOptions | |
| BoxedObject RebaseOptions Source # | |
Defined in GI.Ggit.Structs.RebaseOptions Methods boxedType :: RebaseOptions -> IO GType # | |
noRebaseOptions :: Maybe RebaseOptions Source #
A convenience alias for Nothing :: Maybe RebaseOptions.
Methods
Overloaded methods
copy
Arguments
| :: (HasCallStack, MonadIO m) | |
| => RebaseOptions |
|
| -> m (Maybe RebaseOptions) | Returns: a newly allocated |
Copies rebaseOptions into a newly allocated RebaseOptions.
free
Arguments
| :: (HasCallStack, MonadIO m) | |
| => RebaseOptions |
|
| -> m () |
Frees rebaseOptions.
getCheckoutOptions
rebaseOptionsGetCheckoutOptions Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => RebaseOptions |
|
| -> m (Maybe CheckoutOptions) | Returns: the checkout options or |
Get the checkout options object or Nothing if not set.
getQuiet
rebaseOptionsGetQuiet Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => RebaseOptions |
|
| -> 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 |
|
| -> m (Maybe Text) | Returns: the name of the notes reference or |
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
Arguments
| :: (HasCallStack, MonadIO m) | |
| => m RebaseOptions | Returns: a newly allocated |
Creates a new RebaseOptions.
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 |
|
| -> Bool |
|
| -> 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 |
|
| -> Text |
|
| -> 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.