blob: 55f43bd9b82016e11ac3d5c29e49d27cef252b54 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
|
#pragma once
#include <util/generic/fwd.h>
#include <util/generic/string.h>
/**
* Search the environment list provided by the host environment for associated variable.
*
* @param key String identifying the name of the environmental variable to look for
* @param def String that returns if environmental variable not found by key
*
* @return String that is associated with the matched environment variable or empty string if
* such variable is missing.
*
* @note Use it only in pair with `SetEnv` as there may be inconsistency in their behaviour
* otherwise.
* @note Calls to `GetEnv` and `SetEnv` from different threads must be synchronized.
* @see SetEnv
*/
TString GetEnv(const TString& key, const TString& def = TString());
/**
* Search the environment list provided by the host environment for associated variable.
*
* @param key String identifying the name of the environmental variable to look for
*
* @return String that is associated with the matched environment
* variable or empty optional value if such variable is missing.
*
* @throws TSystemError If name of the variable has invalid format
*
* @note Use it only in pair with `SetEnv` as there may be inconsistency
* in their behaviour otherwise.
* @note Calls to `TryGetEnv` and `SetEnv` from different threads must be synchronized.
* @see SetEnv
*/
TMaybe<TString> TryGetEnv(const TString& key);
/**
* Add or change environment variable provided by the host environment.
*
* @param key String identifying the name of the environment variable to set or change
* @param value Value to assign
* @note Use it only in pair with `GetEnv` as there may be inconsistency in their behaviour
* otherwise.
* @note Calls to `GetEnv` and `SetEnv` from different threads must be synchronized.
* @see GetEnv
*/
void SetEnv(const TString& key, const TString& value);
/**
* Remove environment variable from the host environment.
*
* @param key String identifying the name of the environment variable to remove
*
* @note If key does not exist in the environment, then the environment is unchanged,
* and the function returns normally.
* @note Calls to `GetEnv` and `SetEnv` from different threads must be synchronized.
* @see GetEnv
*/
void UnsetEnv(const TString& key);
|
