Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria (inaki@blueleaf.cc) |
Safe Haskell | None |
Language | Haskell2010 |
Represents the options used when cloning.
Synopsis
- newtype CloneOptions = CloneOptions (ManagedPtr CloneOptions)
- class (GObject o, IsDescendantOf CloneOptions o) => IsCloneOptions o
- toCloneOptions :: (MonadIO m, IsCloneOptions o) => o -> m CloneOptions
- noCloneOptions :: Maybe CloneOptions
- cloneOptionsGetCheckoutBranch :: (HasCallStack, MonadIO m, IsCloneOptions a) => a -> m Text
- cloneOptionsGetFetchOptions :: (HasCallStack, MonadIO m, IsCloneOptions a) => a -> m FetchOptions
- cloneOptionsGetIsBare :: (HasCallStack, MonadIO m, IsCloneOptions a) => a -> m Bool
- cloneOptionsGetLocal :: (HasCallStack, MonadIO m, IsCloneOptions a) => a -> m CloneLocal
- cloneOptionsNew :: (HasCallStack, MonadIO m) => m CloneOptions
- cloneOptionsSetCheckoutBranch :: (HasCallStack, MonadIO m, IsCloneOptions a) => a -> Maybe Text -> m ()
- cloneOptionsSetFetchOptions :: (HasCallStack, MonadIO m, IsCloneOptions a) => a -> Maybe FetchOptions -> m ()
- cloneOptionsSetIsBare :: (HasCallStack, MonadIO m, IsCloneOptions a) => a -> Bool -> m ()
- cloneOptionsSetLocal :: (HasCallStack, MonadIO m, IsCloneOptions a) => a -> CloneLocal -> m ()
Exported types
newtype CloneOptions Source #
Memory-managed wrapper type.
CloneOptions (ManagedPtr CloneOptions) |
Instances
GObject CloneOptions Source # | |
Defined in GI.Ggit.Objects.CloneOptions gobjectType :: IO GType | |
HasParentTypes CloneOptions Source # | |
Defined in GI.Ggit.Objects.CloneOptions | |
type ParentTypes CloneOptions Source # | |
Defined in GI.Ggit.Objects.CloneOptions |
class (GObject o, IsDescendantOf CloneOptions o) => IsCloneOptions o Source #
Type class for types which can be safely cast to CloneOptions
, for instance with toCloneOptions
.
Instances
(GObject o, IsDescendantOf CloneOptions o) => IsCloneOptions o Source # | |
Defined in GI.Ggit.Objects.CloneOptions |
toCloneOptions :: (MonadIO m, IsCloneOptions o) => o -> m CloneOptions Source #
Cast to CloneOptions
, for types for which this is known to be safe. For general casts, use castTo
.
noCloneOptions :: Maybe CloneOptions Source #
A convenience alias for Nothing
:: Maybe
CloneOptions
.
Methods
getCheckoutBranch
cloneOptionsGetCheckoutBranch Source #
:: (HasCallStack, MonadIO m, IsCloneOptions a) | |
=> a |
|
-> m Text | Returns: the name of the branch to checkout or |
Gets the name of the branch to checkout or Nothing
.
getFetchOptions
cloneOptionsGetFetchOptions Source #
:: (HasCallStack, MonadIO m, IsCloneOptions a) | |
=> a |
|
-> m FetchOptions | Returns: the fetch options or |
Get the fetch options object or Nothing
if not set.
getIsBare
cloneOptionsGetIsBare Source #
:: (HasCallStack, MonadIO m, IsCloneOptions a) | |
=> a |
|
-> m Bool | Returns: |
Gets if the repository will be bare.
getLocal
:: (HasCallStack, MonadIO m, IsCloneOptions a) | |
=> a |
|
-> m CloneLocal | Returns: the local clone setting. |
Get setting for bypassing the git-aware transport when cloning. The default auto setting bypasses the git-aware transport for local paths, but use a normal fetch for file:// URIs.
new
:: (HasCallStack, MonadIO m) | |
=> m CloneOptions | Returns: a newly allocated |
Creates a new CloneOptions
.
setCheckoutBranch
cloneOptionsSetCheckoutBranch Source #
:: (HasCallStack, MonadIO m, IsCloneOptions a) | |
=> a |
|
-> Maybe Text |
|
-> m () |
Gives the name of the branch to checkout. Nothing
means
use the remote's HEAD.
setFetchOptions
cloneOptionsSetFetchOptions Source #
:: (HasCallStack, MonadIO m, IsCloneOptions a) | |
=> a |
|
-> Maybe FetchOptions |
|
-> m () |
Set the fetch options object.
setIsBare
cloneOptionsSetIsBare Source #
:: (HasCallStack, MonadIO m, IsCloneOptions a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether to clone a bare repository.
setLocal
:: (HasCallStack, MonadIO m, IsCloneOptions a) | |
=> a |
|
-> CloneLocal |
|
-> m () |
Set setting for bypassing the git-aware transport when cloning. The default auto setting bypasses the git-aware transport for local paths, but use a normal fetch for file:// URIs.