用于 write_csv() 的设置。更多...

#include <csv.hpp>

公共成员函数
	csv_writer_options ()=default
	默认构造函数。更多...

sink_info const &	get_sink () const
	返回用于写入器输出的 sink。更多...

table_view const &	get_table () const
	返回将写入到输出的 table。更多...

std::vector< std::string > const &	get_names () const
	返回列名。更多...

std::string const &	get_na_rep () const
	返回用于空条目的字符串。更多...

bool	is_enabled_include_header () const
	是否将头部写入 CSV。更多...

size_type	get_rows_per_chunk () const
	返回每次文件写入处理的最大行数。更多...

std::string const &	get_line_terminator () const
	返回用于分隔行的字符。更多...

char	get_inter_column_delimiter () const
	返回用于分隔列值的字符。更多...

std::string const &	get_true_value () const
	返回用于 INT8 类型中 != 0 值的字符串。更多...

std::string const &	get_false_value () const
	返回用于 INT8 类型中 == 0 值的字符串。更多...

quote_style	get_quoting () const
	返回写入器的引用样式。更多...

void	set_names (std::vector< std::string > names)
	设置可选的相关列名。更多...

void	set_na_rep (std::string val)
	设置用于空条目的字符串。更多...

void	enable_include_header (bool val)
	启用/禁用将头部写入 CSV。更多...

void	size_type
	设置每次文件写入处理的最大行数。更多...

void	set_line_terminator (std::string term)
	设置用于分隔行的字符。更多...

void	set_inter_column_delimiter (char delim)
	设置用于分隔列值的字符。更多...

void	set_true_value (std::string val)
	设置用于 INT8 类型中 != 0 值的字符串。更多...

void	set_false_value (std::string val)
	设置用于 INT8 类型中 == 0 值的字符串。更多...

void	set_table (table_view const &table)
	(重新)设置要写入的 table。更多...

void	set_quoting (quote_style quoting)
	设置写入器的引用样式。更多...

静态公共成员函数
static csv_writer_options_builder	builder (sink_info const &sink, table_view const &table)
	创建用于构建 `csv_writer_options` 的 builder。更多...

详细描述

用于 write_csv() 的设置。

定义于文件 csv.hpp 的第 1372 行。

构造函数和析构函数文档

◆ csv_writer_options()

cudf::io::csv_writer_options::csv_writer_options ( )

explicitdefault

默认构造函数。

添加此构造函数是因为 Cython 要求一个默认构造函数以便在栈上创建对象。

成员函数文档

◆ builder()

static csv_writer_options_builder cudf::io::csv_writer_options::builder	(	sink_info const &	sink,
		table_view const &	table
	)

static

创建用于构建 csv_writer_options 的 builder。

参数

sink	用于写入器输出的 sink
table	将写入到输出的 Table

返回值: 用于构建 csv_writer_options 的 Builder

◆ enable_include_header()

void cudf::io::csv_writer_options::enable_include_header ( bool val )

inline

启用/禁用将头部写入 CSV。

参数

val	用于启用/禁用的布尔值

定义于文件 csv.hpp 的第 1529 行。

◆ get_false_value()

std::string const& cudf::io::csv_writer_options::get_false_value ( ) const

inline

返回用于 INT8 类型中 == 0 值的字符串。

返回值: 用于 INT8 类型中 == 0 值的字符串

定义于文件 csv.hpp 的第 1495 行。

◆ get_inter_column_delimiter()

char cudf::io::csv_writer_options::get_inter_column_delimiter ( ) const

inline

返回用于分隔列值的字符。

返回值: 用于分隔列值的字符。

定义于文件 csv.hpp 的第 1481 行。

◆ get_line_terminator()

std::string const& cudf::io::csv_writer_options::get_line_terminator ( ) const

inline

返回用于分隔行的字符。

返回值: 用于分隔行的字符

定义于文件 csv.hpp 的第 1474 行。

◆ get_na_rep()

std::string const& cudf::io::csv_writer_options::get_na_rep ( ) const

inline

返回用于空条目的字符串。

返回值: 用于空条目的字符串

定义于文件 csv.hpp 的第 1453 行。

◆ get_names()

std::vector<std::string> const& cudf::io::csv_writer_options::get_names ( ) const

inline

返回列名。

返回值: 输出文件中的列名

定义于文件 csv.hpp 的第 1446 行。

◆ get_quoting()

quote_style cudf::io::csv_writer_options::get_quoting ( ) const

inline

返回写入器的引用样式。

注意：仅支持 MINIMAL 和 NONE。

MINIMAL：包含特殊字符（如行分隔符、字段分隔符/引号）的字符串列将被引用。
NONE：不对任何列进行引用。

返回值: quote_style 写入器的引用样式

定义于文件 csv.hpp 的第 1507 行。

◆ get_rows_per_chunk()

size_type cudf::io::csv_writer_options::get_rows_per_chunk ( ) const

inline

返回每次文件写入处理的最大行数。

返回值: 每次文件写入处理的最大行数

定义于文件 csv.hpp 的第 1467 行。

◆ get_sink()

sink_info const& cudf::io::csv_writer_options::get_sink ( ) const

inline

返回用于写入器输出的 sink。

返回值: 用于写入器输出的 sink

定义于文件 csv.hpp 的第 1432 行。

◆ get_table()

table_view const& cudf::io::csv_writer_options::get_table ( ) const

inline

返回将写入到输出的 table。

返回值: 将写入到输出的 table

定义于文件 csv.hpp 的第 1439 行。

◆ get_true_value()

std::string const& cudf::io::csv_writer_options::get_true_value ( ) const

inline

返回用于 INT8 类型中 != 0 值的字符串。

返回值: 用于 INT8 类型中 != 0 值的字符串

定义于文件 csv.hpp 的第 1488 行。

◆ is_enabled_include_header()

bool cudf::io::csv_writer_options::is_enabled_include_header ( ) const

inline

是否将头部写入 CSV。

返回值: 如果将头部写入 CSV，则为 true

定义于文件 csv.hpp 的第 1460 行。

◆ set_false_value()

void cudf::io::csv_writer_options::set_false_value ( std::string val )

inline

设置用于 INT8 类型中 == 0 值的字符串。

参数

val	用于表示 INT8 类型中 == 0 值的字符串

定义于文件 csv.hpp 的第 1564 行。

◆ set_inter_column_delimiter()

void cudf::io::csv_writer_options::set_inter_column_delimiter ( char delim )

inline

设置用于分隔列值的字符。

参数

delim 用于分隔列值的字符

定义于文件 csv.hpp 的第 1550 行。

◆ set_line_terminator()

void cudf::io::csv_writer_options::set_line_terminator ( std::string term )

inline

设置用于分隔行的字符。

参数

term	用于表示行结束的字符

定义于文件 csv.hpp 的第 1543 行。

◆ set_na_rep()

void cudf::io::csv_writer_options::set_na_rep ( std::string val )

inline

设置用于空条目的字符串。

参数

val	用于表示空值的字符串

定义于文件 csv.hpp 的第 1522 行。

◆ set_names()

void cudf::io::csv_writer_options::set_names ( std::vector< std::string > names )

inline

设置可选的相关列名。

参数

names 相关的列名

定义于文件 csv.hpp 的第 1515 行。

◆ set_quoting()

void cudf::io::csv_writer_options::set_quoting ( quote_style quoting )

inline

设置写入器的引用样式。

注意：仅支持以下引用样式

MINIMAL：包含特殊字符（如行分隔符/字段分隔符/引号）的字符串列将被引用。
NONE：不对任何列进行引用。

参数

quoting 写入器的新引用样式。

定义于文件 csv.hpp 的第 1583 行。

◆ set_rows_per_chunk()

void cudf::io::csv_writer_options::set_rows_per_chunk ( size_type val )

inline

设置每次文件写入处理的最大行数。

参数

val 每块处理的行数

定义于文件 csv.hpp 的第 1536 行。

◆ set_table()

void cudf::io::csv_writer_options::set_table ( table_view const & table )

inline

(重新)设置要写入的 table。

参数

table 要写入的 Table

定义于文件 csv.hpp 的第 1571 行。

◆ set_true_value()

void cudf::io::csv_writer_options::set_true_value ( std::string val )

inline

设置用于 INT8 类型中 != 0 值的字符串。

参数

val	用于表示 INT8 类型中 != 0 值的字符串

定义于文件 csv.hpp 的第 1557 行。

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

csv.hpp

公共成员函数

静态公共成员函数

详细描述

构造函数和析构函数文档

◆ csv_writer_options()

成员函数文档

◆ builder()

◆ enable_include_header()

◆ get_false_value()

◆ get_inter_column_delimiter()

◆ get_line_terminator()

◆ get_na_rep()

◆ get_names()

◆ get_quoting()

◆ get_rows_per_chunk()

◆ get_sink()

◆ get_table()

◆ get_true_value()

◆ is_enabled_include_header()

◆ set_false_value()

◆ set_inter_column_delimiter()

◆ set_line_terminator()

◆ set_na_rep()

◆ set_names()

◆ set_quoting()

◆ set_rows_per_chunk()

◆ set_table()

◆ set_true_value()