ini_builder类 参考

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

#include <ini_builder.hpp>

Public 成员函数
	ini_builder ()
	构造函数
	ini_builder (ini_builder &&other)=default
	移动构造函数
ini_builder &	operator= (ini_builder &&other)=default
	移动赋值运算符
ini_builder &	begin_section (const string &name)
	开始一个新节
ini_builder &	end_section ()
	结束当前节
ini_builder &	key (const string &key)
	设置当前键名
ini_builder &	value (string value)
	设置当前键的值（字符串版本）
ini_builder &	value (const char *value)
	设置当前键的值（C字符串版本）
ini_builder &	value (const string_view value)
	设置当前键的值（字符串视图版本）
ini_builder &	value (int value)
	设置当前键的值（整数版本）
ini_builder &	value (int64_t value)
	设置当前键的值（64位整数版本）
ini_builder &	value (double value)
	设置当前键的值（浮点数版本）
ini_builder &	value (bool value)
	设置当前键的值（布尔值版本）
ini_builder &	value (double value, int precision)
	设置当前键的值（浮点数版本，指定精度）
ini_builder &	value_section (const string &name, function< void(ini_builder &)> func)
	使用函数式方式定义值节
unique_ptr< ini_document >	build () noexcept
	构建文档

详细描述

ini配置格式构建器

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

• 链式调用设置节和键值对
• 支持多种数据类型自动转换
• 支持嵌套节的函数式定义
• 浮点数精度控制
• 自动维护当前节上下文

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

构造及析构函数说明

ini_builder() [1/2]

ini_builder::ini_builder

(

)

构造函数

创建一个新的构建器实例，初始化空文档， 并将当前节设置为全局节。

引用了 ini_builder().

被这些函数引用 begin_section(), end_section(), ini_builder(), ini_builder(), key(), operator=(), value(), value(), value(), value(), value(), value(), value(), value() , 以及 value_section().

ini_builder() [2/2]

ini_builder::ini_builder ( ini_builder && other )

default

移动构造函数

参数

other

源构建器

引用了 ini_builder().

成员函数说明

begin_section()

ini_builder & ini_builder::begin_section

(

const string &

name

)

开始一个新节

参数

name

节名称

返回

自身引用，支持链式调用

创建指定名称的新节，并将其设置为当前节。 后续的键值对操作将添加到此节中。

引用了 ini_builder() , 以及 name().

build()

unique_ptr< ini_document > ini_builder::build ( )

noexcept

构建文档

返回

构建完成的文档对象

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

end_section()

ini_builder & ini_builder::end_section

(

)

结束当前节

返回

自身引用，支持链式调用

将当前节切换回全局节。

引用了 ini_builder().

key()

ini_builder & ini_builder::key

(

const string &

key

)

设置当前键名

参数

key

属性键名

返回

自身引用，支持链式调用

异常

ini_exception

当没有有效的节上下文时抛出

设置当前要操作的键名，后续的 value 调用将使用此键名。

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

被这些函数引用 key().

operator=()

ini_builder & ini_builder::operator= ( ini_builder && other )

default

移动赋值运算符

参数

other

源构建器

返回

自身引用

引用了 ini_builder().

value() [1/8]

ini_builder & ini_builder::value

(

bool

value

)

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

参数

value

布尔值

返回

自身引用，支持链式调用

异常

ini_exception

当没有有效的节或键名时抛出

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

value() [2/8]

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

inline

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

参数

value

属性值

返回

自身引用，支持链式调用

异常

ini_exception

当没有有效的节或键名时抛出

在文件 ini_builder.hpp 第 122 行定义.

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

被这些函数引用 value().

value() [3/8]

ini_builder & ini_builder::value ( const string_view value )

inline

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

参数

value

属性值

返回

自身引用，支持链式调用

异常

ini_exception

当没有有效的节或键名时抛出

在文件 ini_builder.hpp 第 130 行定义.

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

被这些函数引用 value().

value() [4/8]

ini_builder & ini_builder::value

(

double

value

)

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

参数

value

浮点数值

返回

自身引用，支持链式调用

异常

ini_exception

当没有有效的节或键名时抛出

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

value() [5/8]

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

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

参数

value	浮点数值
precision	小数精度

返回

自身引用，支持链式调用

异常

ini_exception

当没有有效的节或键名时抛出

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

value() [6/8]

ini_builder & ini_builder::value

(

int

value

)

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

参数

value

整数值

返回

自身引用，支持链式调用

异常

ini_exception

当没有有效的节或键名时抛出

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

value() [7/8]

ini_builder & ini_builder::value

(

int64_t

value

)

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

参数

value

64位整数值

返回

自身引用，支持链式调用

异常

ini_exception

当没有有效的节或键名时抛出

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

value() [8/8]

ini_builder & ini_builder::value

(

string

value

)

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

参数

value

属性值

返回

自身引用，支持链式调用

异常

ini_exception

当没有有效的节或键名时抛出

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

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

value_section()

ini_builder & ini_builder::value_section	(	const string &	name,
		function< void(ini_builder &)>	func )

使用函数式方式定义值节

参数

name	节名称
func	配置函数，接收ini_builder引用作为参数

返回

自身引用，支持链式调用

异常

ini_exception

当节创建或配置过程中出错时抛出

在一个独立的函数作用域内定义节的内容， 函数执行完毕后自动返回当前节。

引用了 ini_builder() , 以及 name().

---

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

• ini_builder.hpp