cudf::io::reader_column_schema Class Reference

schema element for reader More...

#include <types.hpp>

Public Member Functions
	reader_column_schema (size_type number_of_children)
	Construct a new reader column schema object. More...
	reader_column_schema (host_span< reader_column_schema > const &child_span)
	Construct a new reader column schema object with a span defining the children. More...
reader_column_schema &	add_child (reader_column_schema const &child)
	Add the children metadata of this column. More...
reader_column_schema &	child (size_type i)
	Get reference to a child of this column. More...
reader_column_schema const &	child (size_type i) const
	Get const reference to a child of this column. More...
reader_column_schema &	set_convert_binary_to_strings (bool convert_to_string)
	Specifies whether this column should be written as binary or string data Only valid for the following column types: string, list<int8> More...
reader_column_schema &	set_type_length (int32_t type_length)
	Sets the length of fixed length data. More...
bool	is_enabled_convert_binary_to_strings () const
	Get whether to encode this column as binary or string data. More...
int32_t	get_type_length () const
	Get the length in bytes of this fixed length data. More...
size_t	get_num_children () const
	Get the number of child objects. More...

Detailed Description

schema element for reader

Definition at line 984 of file io/types.hpp.

Constructor & Destructor Documentation

reader_column_schema() [1/2]

cudf::io::reader_column_schema::reader_column_schema ( size_type  number_of_children )

inline

Construct a new reader column schema object.

Parameters

number_of_children

number of child schema objects to default construct

Definition at line 999 of file io/types.hpp.

reader_column_schema() [2/2]

cudf::io::reader_column_schema::reader_column_schema ( host_span< reader_column_schema > const &  child_span )

inline

Construct a new reader column schema object with a span defining the children.

Parameters

child_span

span of child schema objects

Definition at line 1006 of file io/types.hpp.

Member Function Documentation

add_child()

reader_column_schema& cudf::io::reader_column_schema::add_child ( reader_column_schema const &  child )

inline

Add the children metadata of this column.

Parameters

child

The children metadata of this column to add

Returns

this for chaining

Definition at line 1017 of file io/types.hpp.

child() [1/2]

reader_column_schema& cudf::io::reader_column_schema::child ( size_type  i )

inline

Get reference to a child of this column.

Parameters

i	Index of the child to get

Returns

this for chaining

Definition at line 1029 of file io/types.hpp.

child() [2/2]

reader_column_schema const& cudf::io::reader_column_schema::child ( size_type  i ) const

inline

Get const reference to a child of this column.

Parameters

i	Index of the child to get

Returns

this for chaining

Definition at line 1037 of file io/types.hpp.

get_num_children()

size_t cudf::io::reader_column_schema::get_num_children ( ) const

inline

Get the number of child objects.

Returns

number of children

Definition at line 1087 of file io/types.hpp.

get_type_length()

int32_t cudf::io::reader_column_schema::get_type_length ( ) const

inline

Get the length in bytes of this fixed length data.

Returns

The length in bytes of the data type

Definition at line 1080 of file io/types.hpp.

is_enabled_convert_binary_to_strings()

bool cudf::io::reader_column_schema::is_enabled_convert_binary_to_strings ( ) const

inline

Get whether to encode this column as binary or string data.

Returns

Boolean indicating whether to encode this column as binary data

Definition at line 1070 of file io/types.hpp.

set_convert_binary_to_strings()

reader_column_schema& cudf::io::reader_column_schema::set_convert_binary_to_strings ( bool  convert_to_string )

inline

Specifies whether this column should be written as binary or string data Only valid for the following column types: string, list<int8>

Parameters

convert_to_string

True = convert binary to strings False = return binary

Returns

this for chaining

Definition at line 1047 of file io/types.hpp.

set_type_length()

reader_column_schema& cudf::io::reader_column_schema::set_type_length ( int32_t  type_length )

inline

Sets the length of fixed length data.

Parameters

type_length

Size of the data type in bytes

Returns

this for chaining

Definition at line 1059 of file io/types.hpp.

---

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

• io/types.hpp