Public Member Functions | List of all members
cudf::io::csv_writer_options_builder Class Reference

Builder to build options for writer_csv() More...

#include <csv.hpp>

Public Member Functions

 csv_writer_options_builder ()=default
 Default constructor. More...
 
 csv_writer_options_builder (sink_info const &sink, table_view const &table)
 Constructor from sink and table. More...
 
csv_writer_options_buildernames (std::vector< std::string > names)
 Sets optional column names. More...
 
csv_writer_options_builderna_rep (std::string val)
 Sets string to used for null entries. More...
 
csv_writer_options_builderinclude_header (bool val)
 Enables/Disables headers being written to csv. More...
 
csv_writer_options_builderrows_per_chunk (int val)
 Sets maximum number of rows to process for each file write. More...
 
csv_writer_options_builderline_terminator (std::string term)
 Sets character used for separating lines. More...
 
csv_writer_options_builderinter_column_delimiter (char delim)
 Sets character used for separating column values. More...
 
csv_writer_options_buildertrue_value (std::string val)
 Sets string used for values != 0 in INT8 types. More...
 
csv_writer_options_builderfalse_value (std::string val)
 Sets string used for values == 0 in INT8 types. More...
 
csv_writer_options_builderquoting (quote_style quoting)
 Sets the quote style for the writer. More...
 
 operator csv_writer_options && ()
 move csv_writer_options member once it's built.
 
csv_writer_options && build ()
 move csv_writer_options member once it's built. More...
 

Detailed Description

Builder to build options for writer_csv()

Definition at line 1594 of file csv.hpp.

Constructor & Destructor Documentation

◆ csv_writer_options_builder() [1/2]

cudf::io::csv_writer_options_builder::csv_writer_options_builder ( )
explicitdefault

Default constructor.

This has been added since Cython requires a default constructor to create objects on stack.

◆ csv_writer_options_builder() [2/2]

cudf::io::csv_writer_options_builder::csv_writer_options_builder ( sink_info const &  sink,
table_view const &  table 
)
inlineexplicit

Constructor from sink and table.

Parameters
sinkThe sink used for writer output
tableTable to be written to output

Definition at line 1611 of file csv.hpp.

Member Function Documentation

◆ build()

csv_writer_options&& cudf::io::csv_writer_options_builder::build ( )
inline

move csv_writer_options member once it's built.

This has been added since Cython does not support overloading of conversion operators.

Returns
Built csv_writer_options object's r-value reference

Definition at line 1738 of file csv.hpp.

◆ false_value()

csv_writer_options_builder& cudf::io::csv_writer_options_builder::false_value ( std::string  val)
inline

Sets string used for values == 0 in INT8 types.

Parameters
valString to represent values == 0 in INT8 types
Returns
this for chaining

Definition at line 1706 of file csv.hpp.

◆ include_header()

csv_writer_options_builder& cudf::io::csv_writer_options_builder::include_header ( bool  val)
inline

Enables/Disables headers being written to csv.

Parameters
valBoolean value to enable/disable
Returns
this for chaining

Definition at line 1646 of file csv.hpp.

◆ inter_column_delimiter()

csv_writer_options_builder& cudf::io::csv_writer_options_builder::inter_column_delimiter ( char  delim)
inline

Sets character used for separating column values.

Parameters
delimCharacter to delimit column values
Returns
this for chaining

Definition at line 1682 of file csv.hpp.

◆ line_terminator()

csv_writer_options_builder& cudf::io::csv_writer_options_builder::line_terminator ( std::string  term)
inline

Sets character used for separating lines.

Parameters
termCharacter to represent line termination
Returns
this for chaining

Definition at line 1670 of file csv.hpp.

◆ na_rep()

csv_writer_options_builder& cudf::io::csv_writer_options_builder::na_rep ( std::string  val)
inline

Sets string to used for null entries.

Parameters
valString to represent null value
Returns
this for chaining

Definition at line 1634 of file csv.hpp.

◆ names()

csv_writer_options_builder& cudf::io::csv_writer_options_builder::names ( std::vector< std::string >  names)
inline

Sets optional column names.

Parameters
namesColumn names
Returns
this for chaining

Definition at line 1622 of file csv.hpp.

◆ quoting()

csv_writer_options_builder& cudf::io::csv_writer_options_builder::quoting ( quote_style  quoting)
inline

Sets the quote style for the writer.

Only MINIMAL and NONE are supported.

Parameters
quotingThe new quote style for the writer.
Returns
this for chaining

Definition at line 1720 of file csv.hpp.

◆ rows_per_chunk()

csv_writer_options_builder& cudf::io::csv_writer_options_builder::rows_per_chunk ( int  val)
inline

Sets maximum number of rows to process for each file write.

Parameters
valNumber of rows per chunk
Returns
this for chaining

Definition at line 1658 of file csv.hpp.

◆ true_value()

csv_writer_options_builder& cudf::io::csv_writer_options_builder::true_value ( std::string  val)
inline

Sets string used for values != 0 in INT8 types.

Parameters
valString to represent values != 0 in INT8 types
Returns
this for chaining

Definition at line 1694 of file csv.hpp.


The documentation for this class was generated from the following file: