GI.Ggit.Objects.CheckoutOptions

Represents the options used when doign a checkout.

Exported types

newtype CheckoutOptions

Constructors

CheckoutOptions (ManagedPtr CheckoutOptions)

Instances

GObject CheckoutOptions

Methods

gobjectType :: CheckoutOptions -> IO GType

IsObject CheckoutOptions

IsCheckoutOptions CheckoutOptions

class GObject o => IsCheckoutOptions o

Instances

(GObject a, UnknownAncestorError Constraint CheckoutOptions a) => IsCheckoutOptions a

IsCheckoutOptions CheckoutOptions

toCheckoutOptions :: (MonadIO m, IsCheckoutOptions o) => o -> m CheckoutOptions

noCheckoutOptions :: Maybe CheckoutOptions

Methods

getAncestorLabel

checkoutOptionsGetAncestorLabel

Arguments

:: (HasCallStack, MonadIO m, IsCheckoutOptions a)

=> a

options: a CheckoutOptions.

-> m (Maybe Text)

Returns: the checkout ancestor label.

Get the checkout ancestor label.

getBaseline

checkoutOptionsGetBaseline

Arguments

:: (HasCallStack, MonadIO m, IsCheckoutOptions a)

=> a

options: a CheckoutOptions.

-> m Tree

Returns: a Tree.

Get the baseline, i.e. the expected content of workdir. Defaults to HEAD.

getDirMode

checkoutOptionsGetDirMode

Arguments

:: (HasCallStack, MonadIO m, IsCheckoutOptions a)

=> a

options: a CheckoutOptions.

-> m Word32

Returns: the default directory mode.

Get the default checkout directory mode.

getDisableFilters

checkoutOptionsGetDisableFilters

Arguments

:: (HasCallStack, MonadIO m, IsCheckoutOptions a)

=> a

options: a CheckoutOptions.

-> m Bool

Returns: True if filters are disabled, False otherwise.

Get whether filters are disabled.

getFileMode

checkoutOptionsGetFileMode

Arguments

:: (HasCallStack, MonadIO m, IsCheckoutOptions a)

=> a

options: a CheckoutOptions.

-> m Word32

Returns: the default checkout file mode.

Get the default checkout file mode.

getFileOpenFlags

checkoutOptionsGetFileOpenFlags

Arguments

:: (HasCallStack, MonadIO m, IsCheckoutOptions a)

=> a

options: a CheckoutOptions.

-> m Int32

Returns: the checkout file open flags.

Get the checkout file open flags. These flags are platform specific, e.g. on Unix these would include O_CREAT, O_TRUNC, etc.

getNotifyFlags

checkoutOptionsGetNotifyFlags

Arguments

:: (HasCallStack, MonadIO m, IsCheckoutOptions a)

=> a

options: a CheckoutOptions.

-> m [CheckoutNotifyFlags]

Returns: a CheckoutNotifyFlags.

Get the checkout notify flags.

getOurLabel

checkoutOptionsGetOurLabel

Arguments

:: (HasCallStack, MonadIO m, IsCheckoutOptions a)

=> a

options: a CheckoutOptions.

-> m (Maybe Text)

Returns: the checkout our label.

Get the checkout our label.

getPaths

checkoutOptionsGetPaths

Arguments

:: (HasCallStack, MonadIO m, IsCheckoutOptions a)

=> a

options: a CheckoutOptions.

-> m (Maybe [Text])

Returns: a Nothing terminated list of file paths, or Nothing.

Get the list of file paths to checkout.

getStrategy

checkoutOptionsGetStrategy

Arguments

:: (HasCallStack, MonadIO m, IsCheckoutOptions a)

=> a

options: a CheckoutOptions.

-> m [CheckoutStrategy]

Returns: a CheckoutStrategy.

Get the checkout strategy.

getTargetDirectory

checkoutOptionsGetTargetDirectory

Arguments

:: (HasCallStack, MonadIO m, IsCheckoutOptions a)

=> a

options: a CheckoutOptions.

-> m (Maybe Text)

Returns: the checkout target directory.

Get the checkout target directory.

getTheirLabel

checkoutOptionsGetTheirLabel

Arguments

:: (HasCallStack, MonadIO m, IsCheckoutOptions a)

=> a

options: a CheckoutOptions.

-> m (Maybe Text)

Returns: the checkout their label.

Get the checkout their label.

new

checkoutOptionsNew

Arguments

:: (HasCallStack, MonadIO m)

=> m CheckoutOptions

Returns: a CheckoutOptions.

Create a new checkout options object.

setAncestorLabel

checkoutOptionsSetAncestorLabel

Arguments

:: (HasCallStack, MonadIO m, IsCheckoutOptions a)

=> a

options: a CheckoutOptions.

-> Maybe Text

label: the ancestor label.

-> m ()

Set the checkout ancestor label.

setBaseline

checkoutOptionsSetBaseline

Arguments

:: (HasCallStack, MonadIO m, IsCheckoutOptions a, IsTree b)

=> a

options: a CheckoutOptions.

-> Maybe b

tree: a Tree.

-> m ()

Set the baseline, i.e. the expected content of workdir. If tree is set to Nothing, the default (HEAD) will be used as the baseline.

setDirMode

checkoutOptionsSetDirMode

Arguments

:: (HasCallStack, MonadIO m, IsCheckoutOptions a)

=> a

options: a CheckoutOptions.

-> Word32

dirMode: the dir mode.

-> m ()

Set the default checkout directory mode.

setDisableFilters

checkoutOptionsSetDisableFilters

Arguments

:: (HasCallStack, MonadIO m, IsCheckoutOptions a)

=> a

options: a CheckoutOptions.

-> Bool

disable: disable filters.

-> m ()

Set whether to disable filters.

setFileMode

checkoutOptionsSetFileMode

Arguments

:: (HasCallStack, MonadIO m, IsCheckoutOptions a)

=> a

options: a CheckoutOptions.

-> Word32

fileMode: the file mode.

-> m ()

Set the default checkout file mode.

setFileOpenFlags

checkoutOptionsSetFileOpenFlags

Arguments

:: (HasCallStack, MonadIO m, IsCheckoutOptions a)

=> a

options: a CheckoutOptions.

-> Int32

flags: the file open flags.

-> m ()

Set the checkout file open flags. These flags are platform dependent, e.g. on Unix use O_CREAT, O_TRUNC, etc.

setNotifyFlags

checkoutOptionsSetNotifyFlags

Arguments

:: (HasCallStack, MonadIO m, IsCheckoutOptions a)

=> a

options: a CheckoutOptions.

-> [CheckoutNotifyFlags]

flags: a CheckoutNotifyFlags.

-> m ()

Set the checkout notify flags.

setOurLabel

checkoutOptionsSetOurLabel

Arguments

:: (HasCallStack, MonadIO m, IsCheckoutOptions a)

=> a

options: a CheckoutOptions.

-> Maybe Text

label: the our label.

-> m ()

Set the checkout our label.

setPaths

checkoutOptionsSetPaths

Arguments

:: (HasCallStack, MonadIO m, IsCheckoutOptions a)

=> a

options: a CheckoutOptions.

-> Maybe [Text]

paths: a Nothing terminated list of paths.

-> m ()

Set the list of file paths to checkout. If paths is Nothing, then all files will be checked out.

setStrategy

checkoutOptionsSetStrategy

Arguments

:: (HasCallStack, MonadIO m, IsCheckoutOptions a)

=> a

options: a CheckoutOptions.

-> [CheckoutStrategy]

strategy: a CheckoutStrategy.

-> m ()

Set the checkout strategy.

setTargetDirectory

checkoutOptionsSetTargetDirectory

Arguments

:: (HasCallStack, MonadIO m, IsCheckoutOptions a)

=> a

options: a CheckoutOptions.

-> Maybe Text

directory: the target directory.

-> m ()

Set the checkout target directory.

setTheirLabel

checkoutOptionsSetTheirLabel

Arguments

:: (HasCallStack, MonadIO m, IsCheckoutOptions a)

=> a

options: a CheckoutOptions.

-> Maybe Text

label: the their label.

-> m ()

Set the checkout their label.

Properties

ancestorLabel

clearCheckoutOptionsAncestorLabel :: (MonadIO m, IsCheckoutOptions o) => o -> m ()

constructCheckoutOptionsAncestorLabel :: IsCheckoutOptions o => Text -> IO (GValueConstruct o)

getCheckoutOptionsAncestorLabel :: (MonadIO m, IsCheckoutOptions o) => o -> m (Maybe Text)

setCheckoutOptionsAncestorLabel :: (MonadIO m, IsCheckoutOptions o) => o -> Text -> m ()

baseline

clearCheckoutOptionsBaseline :: (MonadIO m, IsCheckoutOptions o) => o -> m ()

constructCheckoutOptionsBaseline :: (IsCheckoutOptions o, IsTree a) => a -> IO (GValueConstruct o)

getCheckoutOptionsBaseline :: (MonadIO m, IsCheckoutOptions o) => o -> m Tree

setCheckoutOptionsBaseline :: (MonadIO m, IsCheckoutOptions o, IsTree a) => o -> a -> m ()

dirMode

constructCheckoutOptionsDirMode :: IsCheckoutOptions o => Word32 -> IO (GValueConstruct o)

getCheckoutOptionsDirMode :: (MonadIO m, IsCheckoutOptions o) => o -> m Word32

setCheckoutOptionsDirMode :: (MonadIO m, IsCheckoutOptions o) => o -> Word32 -> m ()

disableFilters

constructCheckoutOptionsDisableFilters :: IsCheckoutOptions o => Bool -> IO (GValueConstruct o)

getCheckoutOptionsDisableFilters :: (MonadIO m, IsCheckoutOptions o) => o -> m Bool

setCheckoutOptionsDisableFilters :: (MonadIO m, IsCheckoutOptions o) => o -> Bool -> m ()

fileMode

constructCheckoutOptionsFileMode :: IsCheckoutOptions o => Word32 -> IO (GValueConstruct o)

getCheckoutOptionsFileMode :: (MonadIO m, IsCheckoutOptions o) => o -> m Word32

setCheckoutOptionsFileMode :: (MonadIO m, IsCheckoutOptions o) => o -> Word32 -> m ()

fileOpenFlags

constructCheckoutOptionsFileOpenFlags :: IsCheckoutOptions o => Int32 -> IO (GValueConstruct o)

getCheckoutOptionsFileOpenFlags :: (MonadIO m, IsCheckoutOptions o) => o -> m Int32

setCheckoutOptionsFileOpenFlags :: (MonadIO m, IsCheckoutOptions o) => o -> Int32 -> m ()

notifyFlags

constructCheckoutOptionsNotifyFlags :: IsCheckoutOptions o => [CheckoutNotifyFlags] -> IO (GValueConstruct o)

getCheckoutOptionsNotifyFlags :: (MonadIO m, IsCheckoutOptions o) => o -> m [CheckoutNotifyFlags]

setCheckoutOptionsNotifyFlags :: (MonadIO m, IsCheckoutOptions o) => o -> [CheckoutNotifyFlags] -> m ()

ourLabel

clearCheckoutOptionsOurLabel :: (MonadIO m, IsCheckoutOptions o) => o -> m ()

constructCheckoutOptionsOurLabel :: IsCheckoutOptions o => Text -> IO (GValueConstruct o)

getCheckoutOptionsOurLabel :: (MonadIO m, IsCheckoutOptions o) => o -> m (Maybe Text)

setCheckoutOptionsOurLabel :: (MonadIO m, IsCheckoutOptions o) => o -> Text -> m ()

strategy

constructCheckoutOptionsStrategy :: IsCheckoutOptions o => [CheckoutStrategy] -> IO (GValueConstruct o)

getCheckoutOptionsStrategy :: (MonadIO m, IsCheckoutOptions o) => o -> m [CheckoutStrategy]

setCheckoutOptionsStrategy :: (MonadIO m, IsCheckoutOptions o) => o -> [CheckoutStrategy] -> m ()

targetDirectory

clearCheckoutOptionsTargetDirectory :: (MonadIO m, IsCheckoutOptions o) => o -> m ()

constructCheckoutOptionsTargetDirectory :: IsCheckoutOptions o => Text -> IO (GValueConstruct o)

getCheckoutOptionsTargetDirectory :: (MonadIO m, IsCheckoutOptions o) => o -> m (Maybe Text)

setCheckoutOptionsTargetDirectory :: (MonadIO m, IsCheckoutOptions o) => o -> Text -> m ()

theirLabel

clearCheckoutOptionsTheirLabel :: (MonadIO m, IsCheckoutOptions o) => o -> m ()

constructCheckoutOptionsTheirLabel :: IsCheckoutOptions o => Text -> IO (GValueConstruct o)

getCheckoutOptionsTheirLabel :: (MonadIO m, IsCheckoutOptions o) => o -> m (Maybe Text)

setCheckoutOptionsTheirLabel :: (MonadIO m, IsCheckoutOptions o) => o -> Text -> m ()