libcudf  24.02.00
Public Member Functions | List of all members
cudf::io::avro_reader_options_builder Class Reference

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

#include <avro.hpp>

Public Member Functions

 avro_reader_options_builder ()=default
 Default constructor. More...
 
 avro_reader_options_builder (source_info src)
 Constructor from source info. More...
 
avro_reader_options_buildercolumns (std::vector< std::string > col_names)
 Set names of the column to be read. More...
 
avro_reader_options_builderskip_rows (size_type val)
 Sets number of rows to skip. More...
 
avro_reader_options_buildernum_rows (size_type val)
 Sets number of rows to read. More...
 
 operator avro_reader_options && ()
 move avro_reader_options member once it's built.
 
avro_reader_options && build ()
 move avro_reader_options member once it's built. More...
 

Detailed Description

Builder to build options for read_avro().

Definition at line 132 of file avro.hpp.

Constructor & Destructor Documentation

◆ avro_reader_options_builder() [1/2]

cudf::io::avro_reader_options_builder::avro_reader_options_builder ( )
default

Default constructor.

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

◆ avro_reader_options_builder() [2/2]

cudf::io::avro_reader_options_builder::avro_reader_options_builder ( source_info  src)
inlineexplicit

Constructor from source info.

Parameters
srcThe source information used to read avro file

Definition at line 148 of file avro.hpp.

Member Function Documentation

◆ build()

avro_reader_options&& cudf::io::avro_reader_options_builder::build ( )
inline

move avro_reader_options member once it's built.

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

Returns
Built avro_reader_options object's r-value reference

Definition at line 198 of file avro.hpp.

◆ columns()

avro_reader_options_builder& cudf::io::avro_reader_options_builder::columns ( std::vector< std::string >  col_names)
inline

Set names of the column to be read.

Parameters
col_namesVector of column names
Returns
this for chaining

Definition at line 156 of file avro.hpp.

◆ num_rows()

avro_reader_options_builder& cudf::io::avro_reader_options_builder::num_rows ( size_type  val)
inline

Sets number of rows to read.

Parameters
valNumber of rows to read after skip
Returns
this for chaining

Definition at line 180 of file avro.hpp.

◆ skip_rows()

avro_reader_options_builder& cudf::io::avro_reader_options_builder::skip_rows ( size_type  val)
inline

Sets number of rows to skip.

Parameters
valNumber of rows to skip from start
Returns
this for chaining

Definition at line 168 of file avro.hpp.


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