Copyright	(c) 2017 Red Hat Inc.
License	LGPL
Maintainer	https://github.com/weldr
Stability	alpha
Portability	portable
Safe Haskell	None
Language	Haskell2010

Data.ContentStore.Config

Description

Manage the content store's internal config file.

Synopsis

Documentation

data Config Source #

Configuration information needed by the content store.

Constructors

Config
Fields confHash :: Text What `DigestAlgorithm` is in use by this content store? While we do support several different algorithms, only one can ever be in use by a single content store. Note that the `ContentStore` record also stores this piece of information. The difference is that here, we are only storing the text representation as given in a config file.

Instances

FromJSON Config Source #
Methods parseJSON :: Value -> Parser Config # parseJSONList :: Value -> Parser [Config] #
ToJSON Config Source #
Methods toJSON :: Config -> Value # toEncoding :: Config -> Encoding # toJSONList :: [Config] -> Value # toEncodingList :: [Config] -> Encoding #

defaultConfig :: Config Source #

Construct a default Config record useful for when creating a new ContentStore, as with mkContentStore. Among other things, this is where the default hash algorithm is defined.

readConfig :: FilePath -> IO (Either Text Config) Source #

Read a config file on disk, returning the Config record on success and an error message on error. This function is typically not useful outside of content store internals.

writeConfig :: FilePath -> Config -> IO () Source #

Write a Config object to disk. This function is typically not useful outside of content store internals.