opt-env-conf-0.9.0.0: Settings parsing for Haskell: command-line arguments, environment variables, and configuration values.

Safe Haskell	Safe-Inferred
Language	Haskell2010

OptEnvConf.Completion

Synopsis

generateBashCompletionScript :: Path Abs File -> String -> IO ()
bashCompletionScript :: Path Abs File -> String -> String
generateZshCompletionScript :: Path Abs File -> String -> IO ()
zshCompletionScript :: Path Abs File -> String -> String
generateFishCompletionScript :: Path Abs File -> String -> IO ()
fishCompletionScript :: Path Abs File -> String -> String
runCompletionQuery :: Parser a -> Bool -> Int -> [String] -> IO ()
pureCompletionQuery :: Parser a -> Int -> [String] -> [Completion Suggestion]
data Completion a = Completion {
- completionSuggestion :: !a
- completionDescription :: !(Maybe String)
}
evalCompletions :: String -> [Completion Suggestion] -> IO [Completion String]
evalCompletion :: String -> Completion Suggestion -> IO [Completion String]
data Suggestion
- = SuggestionBare !String
- | SuggestionCompleter !Completer
evalSuggestion :: String -> Suggestion -> IO [String]

Documentation

generateBashCompletionScript :: Path Abs File -> String -> IO () Source #

bashCompletionScript :: Path Abs File -> String -> String Source #

Generated bash shell completion script

generateZshCompletionScript :: Path Abs File -> String -> IO () Source #

zshCompletionScript :: Path Abs File -> String -> String Source #

Generated zsh shell completion script

generateFishCompletionScript :: Path Abs File -> String -> IO () Source #

fishCompletionScript :: Path Abs File -> String -> String Source #

Generated fish shell completion script

runCompletionQuery Source #

Arguments

:: Parser a
-> Bool	Enriched
-> Int	Where completion is invoked (inbetween arguments)
-> [String]
-> IO ()

pureCompletionQuery :: Parser a -> Int -> [String] -> [Completion Suggestion] Source #

data Completion a Source #

Constructors

Completion
Fields completionSuggestion :: !a Completion completionDescription :: !(Maybe String) Description

Instances

Instances details

IsString str => IsString (Completion str) Source #
Instance details Defined in OptEnvConf.Completion Methods fromString :: String -> Completion str #
Show a => Show (Completion a) Source #
Instance details Defined in OptEnvConf.Completion Methods showsPrec :: Int -> Completion a -> ShowS # show :: Completion a -> String # showList :: [Completion a] -> ShowS #
Eq a => Eq (Completion a) Source #
Instance details Defined in OptEnvConf.Completion Methods (==) :: Completion a -> Completion a -> Bool # (/=) :: Completion a -> Completion a -> Bool #
Ord a => Ord (Completion a) Source #
Instance details Defined in OptEnvConf.Completion Methods compare :: Completion a -> Completion a -> Ordering # (<) :: Completion a -> Completion a -> Bool # (<=) :: Completion a -> Completion a -> Bool # (>) :: Completion a -> Completion a -> Bool # (>=) :: Completion a -> Completion a -> Bool # max :: Completion a -> Completion a -> Completion a # min :: Completion a -> Completion a -> Completion a #

evalCompletions :: String -> [Completion Suggestion] -> IO [Completion String] Source #

evalCompletion :: String -> Completion Suggestion -> IO [Completion String] Source #

data Suggestion Source #

Constructors

SuggestionBare !String
SuggestionCompleter !Completer

Instances

Instances details

IsString Suggestion Source #
Instance details Defined in OptEnvConf.Completion Methods fromString :: String -> Suggestion #

evalSuggestion :: String -> Suggestion -> IO [String] Source #