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

Contents

Exported types
Methods

Description

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

Constructors

CloneOptions (ManagedPtr CloneOptions)

Instances

Instances details

Eq CloneOptions Source #
Instance details Defined in GI.Ggit.Objects.CloneOptions Methods (==) :: CloneOptions -> CloneOptions -> Bool (/=) :: CloneOptions -> CloneOptions -> Bool
GObject CloneOptions Source #
Instance details Defined in GI.Ggit.Objects.CloneOptions
ManagedPtrNewtype CloneOptions Source #
Instance details Defined in GI.Ggit.Objects.CloneOptions Methods toManagedPtr :: CloneOptions -> ManagedPtr CloneOptions
TypedObject CloneOptions Source #
Instance details Defined in GI.Ggit.Objects.CloneOptions Methods glibType :: IO GType
IsGValue CloneOptions Source #	Convert `CloneOptions` to and from `GValue` with `toGValue` and `fromGValue`.
Instance details Defined in GI.Ggit.Objects.CloneOptions Methods toGValue :: CloneOptions -> IO GValue fromGValue :: GValue -> IO CloneOptions
HasParentTypes CloneOptions Source #
Instance details Defined in GI.Ggit.Objects.CloneOptions
type ParentTypes CloneOptions Source #
Instance details Defined in GI.Ggit.Objects.CloneOptions type ParentTypes CloneOptions = '[Object]

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

Instances details

(GObject o, IsDescendantOf CloneOptions o) => IsCloneOptions o Source #
Instance details 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.

Methods

Overloaded methods

getCheckoutBranch

cloneOptionsGetCheckoutBranch Source #

Arguments

:: (HasCallStack, MonadIO m, IsCloneOptions a)
=> a	`options`: a `CloneOptions`.
-> m Text	Returns: the name of the branch to checkout or `Nothing`.

Gets the name of the branch to checkout or Nothing.

getFetchOptions

cloneOptionsGetFetchOptions Source #

Arguments

:: (HasCallStack, MonadIO m, IsCloneOptions a)
=> a	`options`: a `CloneOptions`.
-> m FetchOptions	Returns: the fetch options or `Nothing`.

Get the fetch options object or Nothing if not set.

getIsBare

cloneOptionsGetIsBare Source #

Arguments

:: (HasCallStack, MonadIO m, IsCloneOptions a)
=> a	`options`: a `CloneOptions`.
-> m Bool	Returns: `True` to clone a bare repository.

Gets if the repository will be bare.

getLocal

cloneOptionsGetLocal Source #

Arguments

:: (HasCallStack, MonadIO m, IsCloneOptions a)
=> a	`options`: a `CloneOptions`.
-> 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

cloneOptionsNew Source #

Arguments

:: (HasCallStack, MonadIO m)
=> m CloneOptions	Returns: a newly allocated `CloneOptions`.

Creates a new CloneOptions.

setCheckoutBranch

cloneOptionsSetCheckoutBranch Source #

Arguments

:: (HasCallStack, MonadIO m, IsCloneOptions a)
=> a	`options`: a `CloneOptions`.
-> Maybe Text	`checkoutBranch`: the name of the branch to checkout or `Nothing`.
-> m ()

Gives the name of the branch to checkout. Nothing means use the remote's HEAD.

setFetchOptions

cloneOptionsSetFetchOptions Source #

Arguments

:: (HasCallStack, MonadIO m, IsCloneOptions a)
=> a	`options`: a `CloneOptions`.
-> Maybe FetchOptions	`fetchOptions`: a `FetchOptions` or `Nothing`.
-> m ()

Set the fetch options object.

setIsBare

cloneOptionsSetIsBare Source #

Arguments

:: (HasCallStack, MonadIO m, IsCloneOptions a)
=> a	`options`: a `CloneOptions`.
-> Bool	`bare`: `True` to clone a bare repository.
-> m ()

Sets whether to clone a bare repository.

setLocal

cloneOptionsSetLocal Source #

Arguments

:: (HasCallStack, MonadIO m, IsCloneOptions a)
=> a	`options`: a `CloneOptions`.
-> CloneLocal	`local`: the local clone setting.
-> 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.