Program utilities and main context

Classes
class	eagine::application_config
	Class for reading application configuration. More...
class	eagine::application_config_value< T, As >
	Class wrapping values that can be loaded from application_config. More...
class	eagine::build_info
	Class providing basic system information. More...
class	eagine::data_compressor
	Class implementing data compression and decompresson. More...
struct	eagine::main_ctx_options
	Structure storing customization options for main context. More...
class	eagine::main_ctx
	Class for a single-instance object providing useful information ans services. More...
class	eagine::main_ctx_object_parent_info
	Helper class used to initialize main context objects. More...
class	eagine::main_ctx_object
	Base class for main context objects. More...
class	eagine::basic_program_parameter
	Base class for pre-declared program parameter. More...
class	eagine::program_parameter< T >
	Class template for pre-declared program parameter. More...
class	eagine::program_parameter< void >
	Template specialization for pre-declared program parameter without value. More...
class	eagine::program_parameter_alias< T >
	Alias (alternative tags) for another declared program parameter. More...
class	eagine::program_arg
	Class representing a single main function (command-line) argument. More...
class	eagine::program_args
	Class wrapping the main function arguments, providing a convenient API. More...
class	eagine::system_info
	Class providing basic system information. More...
class	eagine::user_info
	Class providing user-related information. More...
class	eagine::process_watchdog
	Class implementing process watchdog functionality. More...

Typedefs
using	eagine::main_ctx_parent = const main_ctx_object_parent_info &
	Alias for main_ctx_object_parent_info parameter type.

Enumerations
enum	eagine::data_compression_level { eagine::data_compression_level::none, eagine::data_compression_level::lowest, eagine::data_compression_level::normal, eagine::data_compression_level::highest }
	Data compression level enumeration. More...

Functions
static auto	eagine::get_environment_variable (string_view variable_name) noexcept -> optionally_valid< string_view >
	Returns the value in the specified environment variable. More...

Detailed Description

Enumeration Type Documentation

data_compression_level

enum eagine::data_compression_level

strong

Data compression level enumeration.

See also

data_compressor

Enumerator
none	No compression.
lowest	Fastest compression method lowest compression level.
normal	Normal compression level.
highest	Slowest compression method highest compression level.

Function Documentation

get_environment_variable()

static auto eagine::get_environment_variable ( string_view  variable_name ) -> optionally_valid<string_view>

inlinestaticnoexcept

Returns the value in the specified environment variable.

See also

application_config

Examples

eagine/environment.cpp.