env_builder类 参考

env配置格式构建器 更多...

#include <env_builder.hpp>

Public 成员函数
	env_builder ()
	构造函数
	env_builder (env_builder &&other) noexcept=default
	移动构造函数
env_builder &	operator= (env_builder &&other) noexcept=default
	移动赋值运算符
env_builder &	key (string key) noexcept
	设置当前键名
env_builder &	unquoted () noexcept
	设置为无引号模式
env_builder &	single_quoted () noexcept
	设置为单引号模式
env_builder &	double_quoted () noexcept
	设置为双引号模式
env_builder &	exported (bool exported=true) noexcept
	设置导出标记
env_builder &	value (string value)
	设置当前键的值（字符串版本）
env_builder &	value (const char *value)
	设置当前键的值（C字符串版本）
env_builder &	value (const string_view value)
	设置当前键的值（字符串视图版本）
env_builder &	value (int value)
	设置当前键的值（整数版本）
env_builder &	value (int64_t value)
	设置当前键的值（64位整数版本）
env_builder &	value (double value)
	设置当前键的值（浮点数版本）
env_builder &	value (bool value)
	设置当前键的值（布尔值版本）
env_builder &	value (double value, int precision)
	设置当前键的值（浮点数版本，指定精度）
env_builder &	comment (string text) noexcept
	添加注释
env_builder &	blank_line ()
	添加空行
env_builder &	add (string key, string value)
	直接添加键值对（字符串版本）
env_builder &	add (string key, const string_view value)
	直接添加键值对（字符串视图版本）
env_builder &	add (string key, const char *value)
	直接添加键值对（C字符串版本）
env_builder &	add (string key, int value)
	直接添加键值对（整数版本）
env_builder &	add (string key, int64_t value)
	直接添加键值对（64位整数版本）
env_builder &	add (string key, double value)
	直接添加键值对（浮点数版本）
env_builder &	add (string key, bool value)
	直接添加键值对（布尔值版本）
env_builder &	add_export (string key, string value)
	添加导出变量
unique_ptr< env_document >	build () noexcept
	构建文档

详细描述

env配置格式构建器

提供流式接口构建env配置格式，支持以下特性：

• 链式调用设置变量键值对
• 支持多种数据类型自动转换
• 可配置引号类型
• 支持export标记
• 可添加注释和空行
• 浮点数精度控制

在文件 env_builder.hpp 第 40 行定义.

构造及析构函数说明

env_builder() [1/2]

env_builder::env_builder

(

)

构造函数

创建一个新的构建器实例，初始化空文档。

引用了 env_builder().

被这些函数引用 add(), add(), add(), add(), add(), add(), add(), add_export(), blank_line(), comment(), double_quoted(), env_builder(), env_builder(), exported(), key(), operator=(), single_quoted(), unquoted(), value(), value(), value(), value(), value(), value(), value() , 以及 value().

env_builder() [2/2]

env_builder::env_builder ( env_builder && other )

defaultnoexcept

移动构造函数

参数

other

源构建器

引用了 env_builder().

成员函数说明

add() [1/7]

env_builder & env_builder::add	(	string	key,
		bool	value )

直接添加键值对（布尔值版本）

参数

key	变量键名
value	布尔值

返回

自身引用，支持链式调用

引用了 env_builder(), key() , 以及 value().

add() [2/7]

env_builder & env_builder::add ( string key, const char * value )

inline

直接添加键值对（C字符串版本）

参数

key	变量键名
value	变量值

返回

自身引用，支持链式调用

在文件 env_builder.hpp 第 203 行定义.

引用了 add(), env_builder(), key(), move() , 以及 value().

被这些函数引用 add().

add() [3/7]

env_builder & env_builder::add ( string key, const string_view value )

inline

直接添加键值对（字符串视图版本）

参数

key	变量键名
value	变量值

返回

自身引用，支持链式调用

在文件 env_builder.hpp 第 195 行定义.

引用了 add(), env_builder(), key(), move() , 以及 value().

被这些函数引用 add().

add() [4/7]

env_builder & env_builder::add	(	string	key,
		double	value )

直接添加键值对（浮点数版本）

参数

key	变量键名
value	浮点数值

返回

自身引用，支持链式调用

引用了 env_builder(), key() , 以及 value().

add() [5/7]

env_builder & env_builder::add	(	string	key,
		int	value )

直接添加键值对（整数版本）

参数

key	变量键名
value	整数值

返回

自身引用，支持链式调用

引用了 env_builder(), key() , 以及 value().

add() [6/7]

env_builder & env_builder::add	(	string	key,
		int64_t	value )

直接添加键值对（64位整数版本）

参数

key	变量键名
value	64位整数值

返回

自身引用，支持链式调用

引用了 env_builder(), key() , 以及 value().

add() [7/7]

env_builder & env_builder::add	(	string	key,
		string	value )

直接添加键值对（字符串版本）

参数

key	变量键名
value	变量值

返回

自身引用，支持链式调用

引用了 env_builder(), key() , 以及 value().

add_export()

env_builder & env_builder::add_export	(	string	key,
		string	value )

添加导出变量

参数

key	变量键名
value	变量值

返回

自身引用，支持链式调用

快捷方法，自动设置export标记。

引用了 env_builder(), key() , 以及 value().

blank_line()

env_builder & env_builder::blank_line

(

)

添加空行

返回

自身引用，支持链式调用

引用了 env_builder().

build()

unique_ptr< env_document > env_builder::build ( )

noexcept

构建文档

返回

构建完成的文档对象

完成构建过程，返回构建好的环境变量文档。 调用后构建器状态被移动，不应继续使用。

comment()

env_builder & env_builder::comment ( string text )

noexcept

添加注释

参数

text

注释文本

返回

自身引用，支持链式调用

引用了 env_builder().

double_quoted()

env_builder & env_builder::double_quoted ( )

noexcept

设置为双引号模式

返回

自身引用，支持链式调用

引用了 double_quoted() , 以及 env_builder().

被这些函数引用 double_quoted().

exported()

env_builder & env_builder::exported ( bool exported = true )

noexcept

设置导出标记

参数

exported

是否导出，默认为true

返回

自身引用，支持链式调用

引用了 env_builder() , 以及 exported().

被这些函数引用 exported().

key()

env_builder & env_builder::key ( string key )

noexcept

设置当前键名

参数

key

变量键名

返回

自身引用，支持链式调用

引用了 env_builder() , 以及 key().

被这些函数引用 add(), add(), add(), add(), add(), add(), add(), add_export() , 以及 key().

operator=()

env_builder & env_builder::operator= ( env_builder && other )

defaultnoexcept

移动赋值运算符

参数

other

源构建器

返回

自身引用

引用了 env_builder().

single_quoted()

env_builder & env_builder::single_quoted ( )

noexcept

设置为单引号模式

返回

自身引用，支持链式调用

引用了 env_builder() , 以及 single_quoted().

被这些函数引用 single_quoted().

unquoted()

env_builder & env_builder::unquoted ( )

noexcept

设置为无引号模式

返回

自身引用，支持链式调用

引用了 env_builder().

value() [1/8]

env_builder & env_builder::value

(

bool

value

)

设置当前键的值（布尔值版本）

参数

value

布尔值

返回

自身引用，支持链式调用

异常

env_exception

当未设置键名时抛出

引用了 env_builder() , 以及 value().

value() [2/8]

env_builder & env_builder::value ( const char * value )

inline

设置当前键的值（C字符串版本）

参数

value

变量值

返回

自身引用，支持链式调用

异常

env_exception

当未设置键名时抛出

在文件 env_builder.hpp 第 117 行定义.

引用了 env_builder(), value() , 以及 value().

被这些函数引用 value().

value() [3/8]

env_builder & env_builder::value ( const string_view value )

inline

设置当前键的值（字符串视图版本）

参数

value

变量值

返回

自身引用，支持链式调用

异常

env_exception

当未设置键名时抛出

在文件 env_builder.hpp 第 125 行定义.

引用了 env_builder(), value() , 以及 value().

被这些函数引用 value().

value() [4/8]

env_builder & env_builder::value

(

double

value

)

设置当前键的值（浮点数版本）

参数

value

浮点数值

返回

自身引用，支持链式调用

异常

env_exception

当未设置键名时抛出

引用了 env_builder() , 以及 value().

value() [5/8]

env_builder & env_builder::value	(	double	value,
		int	precision )

设置当前键的值（浮点数版本，指定精度）

参数

value	浮点数值
precision	小数精度

返回

自身引用，支持链式调用

异常

env_exception

当未设置键名时抛出

引用了 env_builder() , 以及 value().

value() [6/8]

env_builder & env_builder::value

(

int

value

)

设置当前键的值（整数版本）

参数

value

整数值

返回

自身引用，支持链式调用

异常

env_exception

当未设置键名时抛出

引用了 env_builder() , 以及 value().

value() [7/8]

env_builder & env_builder::value

(

int64_t

value

)

设置当前键的值（64位整数版本）

参数

value

64位整数值

返回

自身引用，支持链式调用

异常

env_exception

当未设置键名时抛出

引用了 env_builder() , 以及 value().

value() [8/8]

env_builder & env_builder::value

(

string

value

)

设置当前键的值（字符串版本）

参数

value

变量值

返回

自身引用，支持链式调用

异常

env_exception

当未设置键名时抛出

引用了 env_builder() , 以及 value().

被这些函数引用 add(), add(), add(), add(), add(), add(), add(), add_export(), value(), value(), value(), value(), value(), value(), value() , 以及 value().

---

该类的文档由以下文件生成:

• env_builder.hpp