Copyright	(c) IOcrafts 2024-present
License	BSD
Maintainer	Maurizio Dusi
Stability	stable
Portability	POSIX
Safe Haskell	None
Language	Haskell2010

Config

Description

This module parses a YAML file with configuration options.

Example of conf.yaml:

    remote:
        hostname: sftp.domain.com
        port: 22
        username: username
        password: password
        known_hosts: /home/user/.ssh/known_hosts

Synopsis

data Config = Config {
- configHost :: String
- configPort :: Int
- configUser :: String
- configPassword :: String
- configKnownHosts :: FilePath
}
mkConfig :: YamlConfig -> IO Config

Documentation

data Config Source #

Represents the configuration settings for the application.

Constructors

Config
Fields configHost :: String The host address of the server. configPort :: Int The port number to connect to. configUser :: String The username for authentication. configPassword :: String The password for authentication. configKnownHosts :: FilePath The file path to the known hosts file.

Instances

Instances details

Show Config Source #
Instance details Defined in Config Methods showsPrec :: Int -> Config -> ShowS # show :: Config -> String # showList :: [Config] -> ShowS #

mkConfig :: YamlConfig -> IO Config Source #

Create a Config from a YamlConfig.

This function takes a YamlConfig and extracts the necessary fields to create a Config object. It returns an IO action that produces the resulting Config.