-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Hash-addressed file storage app
--   
--   A command-line interface for maintaining a directory wherein each
--   file's name is a hash of its content.
@package hash-addressed-cli
@version 2.0.0.0

module HashAddressed.App.Command.Type
type Command = ParserInfo (CommandAction ())
type CommandAction a = ExceptT (Seq String) IO a

module HashAddressed.App.HashFunction.Naming
readHashFunctionText :: Text -> Maybe HashFunction
readHashFunctionString :: String -> Maybe HashFunction
showHashFunction :: HashFunction -> String
normalizeHashFunction :: String -> String
hashFunctions :: [(String, HashFunction)]

module HashAddressed.App.HashFunction.Options
hashFunctionRead :: ReadM HashFunction
hashFunctionInstructions :: String

module HashAddressed.App.HashFunction
readHashFunctionText :: Text -> Maybe HashFunction
readHashFunctionString :: String -> Maybe HashFunction
showHashFunction :: HashFunction -> String
normalizeHashFunction :: String -> String
hashFunctionRead :: ReadM HashFunction
hashFunctionInstructions :: String

module HashAddressed.App.Meta.Paths
metaDirectory :: FilePath -> FilePath
configFile :: FilePath -> FilePath

module HashAddressed.App.Meta.Version
data Version
V1 :: Version

module HashAddressed.App.Meta.Reading
readHashFunctionFromConfig :: FilePath -> CommandAction HashFunction

module HashAddressed.App.Verbosity.Type

-- | On non-zero exit code, <tt>stderr</tt> messages are printed regardless
--   of verbosity
data Verbosity
Verbosity :: Bool -> Bool -> Verbosity

-- | Controls whether normal <tt>stdout</tt> output is printed
[quiet] :: Verbosity -> Bool

-- | Controls whether chatty <tt>stderr</tt> output is printed
[verbose] :: Verbosity -> Bool
instance GHC.Classes.Ord HashAddressed.App.Verbosity.Type.Verbosity
instance GHC.Classes.Eq HashAddressed.App.Verbosity.Type.Verbosity

module HashAddressed.App.Verbosity.Printing

-- | For output that one might want to use programmatically
--   
--   Goes to stdout.
--   
--   Can be suppressed with the <tt>--quiet</tt> flag.
putNormalLn :: MonadIO m => Verbosity -> String -> m ()

-- | For extra chatty messages
--   
--   Goes to stderr so that the output that one might want to use
--   programmatically can be captured separately.
--   
--   Does not print unless the <tt>--verbose</tt> flag is used.
putVerboseLn :: MonadIO m => Verbosity -> String -> m ()

module HashAddressed.App.Verbosity.Options
verboseOption :: Parser Bool
quietOption :: Parser Bool
verbosityOption :: Parser Verbosity

module HashAddressed.App.Verbosity

-- | On non-zero exit code, <tt>stderr</tt> messages are printed regardless
--   of verbosity
data Verbosity
Verbosity :: Bool -> Bool -> Verbosity

-- | Controls whether normal <tt>stdout</tt> output is printed
[quiet] :: Verbosity -> Bool

-- | Controls whether chatty <tt>stderr</tt> output is printed
[verbose] :: Verbosity -> Bool

-- | For output that one might want to use programmatically
--   
--   Goes to stdout.
--   
--   Can be suppressed with the <tt>--quiet</tt> flag.
putNormalLn :: MonadIO m => Verbosity -> String -> m ()

-- | For extra chatty messages
--   
--   Goes to stderr so that the output that one might want to use
--   programmatically can be captured separately.
--   
--   Does not print unless the <tt>--verbose</tt> flag is used.
putVerboseLn :: MonadIO m => Verbosity -> String -> m ()
verboseOption :: Parser Bool
quietOption :: Parser Bool
verbosityOption :: Parser Verbosity

module HashAddressed.App.Meta.Initialization
defaultConfigINI :: HashFunction -> Ini
tryInitializeStore :: InitializationType -> Verbosity -> HashFunction -> FilePath -> CommandAction ()

-- | Assumes a store does not already exist
initializeStore :: HashFunction -> FilePath -> CommandAction ()
data InitializationType
CreateNew :: InitializationType
CreateIfNotPresent :: InitializationType

module HashAddressed.App.Meta
defaultConfigINI :: HashFunction -> Ini
tryInitializeStore :: InitializationType -> Verbosity -> HashFunction -> FilePath -> CommandAction ()

-- | Assumes a store does not already exist
initializeStore :: HashFunction -> FilePath -> CommandAction ()
data InitializationType
CreateNew :: InitializationType
CreateIfNotPresent :: InitializationType
metaDirectory :: FilePath -> FilePath
configFile :: FilePath -> FilePath
readHashFunctionFromConfig :: FilePath -> CommandAction HashFunction
data Version
V1 :: Version

module HashAddressed.App.Command.Examples.Initialize
initializeCommand :: Command

module HashAddressed.App.Command.Examples.Write
writeCommand :: Command

module HashAddressed.App.Version
version :: String

module HashAddressed.App.Command.Examples.Version
versionCommand :: Command

module HashAddressed.App.Command.Examples.Main
mainCommand :: Command

module HashAddressed.App.Command.Examples
mainCommand :: Command
initializeCommand :: Command
writeCommand :: Command
versionCommand :: Command