env.hpp File Reference

#include <optional>
#include <string>

Include dependency graph for env.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
namespace	shamcmdopt
	namespace for cli utilities

Functions
std::optional< std::string >	shamcmdopt::getenv_str (const char *env_var)
	Get the content of the environment variable if it exist.
std::string	shamcmdopt::getenv_str_default (const char *env_var, std::string default_val)
	Get the content of the environment variable if it exist, otherwise return the default value.
void	shamcmdopt::register_env_var_doc (std::string env_var, std::string desc)
	Register the documentation of an environment variable.
std::optional< std::string >	shamcmdopt::getenv_str_register (const char *env_var, std::string desc)
	Get the content of the environment variable if it exist and register it documentation.
std::string	shamcmdopt::getenv_str_default_register (const char *env_var, std::string default_val, std::string desc)
	Get the content of the environment variable if it exist and register it documentation, otherwise return the default value.
void	shamcmdopt::print_help_env_var ()
	Print the documentation of the environment variables registered with register_env_var_doc()

Detailed Description

Author

Timothée David–Cléris (tim.s.nosp@m.hamr.nosp@m.ock@p.nosp@m.roto.nosp@m.n.me)

Definition in file env.hpp.