adbc::driver::Option 类参考

一个带类型的选项值包装器。当前它不尝试转换（例如，将 double 选项作为字符串获取）。 更多...

#include <base_driver.h>

类
struct	Unset
	选项未设置。 更多...

公共类型
using	Value = std::variant<Unset, std::string, std::vector<uint8_t>, int64_t, double>
	选项的可能值。

公共成员函数
	Option (const char *value)
	从 C 字符串构造一个选项。NULL 字符串被视作未设置。
	Option (std::string value)
	Option (std::vector< uint8_t > value)
	Option (double value)
	Option (int64_t value)
const Value &	value () const &
Value &	value () &&
bool	has_value () const
	检查是否设置了此选项。
Result< bool >	AsBool () const
	尝试将字符串值解析为布尔值。
Result< int64_t >	AsInt () const
	尝试将字符串或整数值解析为整数。
Result< std::string_view >	AsString () const
	如果该值是字符串，则获取该值。
std::string	Format () const
	提供值的可读摘要。

私有成员函数
AdbcStatusCode	CGet (char *out, size_t *length, AdbcError *error) const
AdbcStatusCode	CGet (uint8_t *out, size_t *length, AdbcError *error) const
AdbcStatusCode	CGet (int64_t *out, AdbcError *error) const
AdbcStatusCode	CGet (double *out, AdbcError *error) const

私有属性
Value	value_

友元
class	ObjectBase

详细描述

一个带类型的选项值包装器。当前它不尝试转换（例如，将 double 选项作为字符串获取）。

成员类型定义文档

Value

using adbc::driver::Option::Value = std::variant<Unset, std::string, std::vector<uint8_t>, int64_t, double>

选项的可能值。

构造函数 & 析构函数文档

Option()

adbc::driver::Option::Option ( const char * value )

inlineexplicit

从 C 字符串构造一个选项。NULL 字符串被视作未设置。

成员函数文档

AsBool()

Result< bool > adbc::driver::Option::AsBool ( ) const

inline

尝试将字符串值解析为布尔值。

AsInt()

Result< int64_t > adbc::driver::Option::AsInt ( ) const

inline

尝试将字符串或整数值解析为整数。

AsString()

Result< std::string_view > adbc::driver::Option::AsString ( ) const

inline

如果该值是字符串，则获取该值。

Format()

std::string adbc::driver::Option::Format ( ) const

inline

提供值的可读摘要。

has_value()

bool adbc::driver::Option::has_value ( ) const

inline

检查是否设置了此选项。

---

此类的文档由以下文件生成

• /adbc/c/driver/framework/base_driver.h