Public Member Functions | Public Attributes | List of all members
cudf::io::column_name_info Struct Reference

Detailed name (and optionally nullability) information for output columns. More...

#include <types.hpp>

Public Member Functions

 column_name_info (std::string _name, std::optional< bool > _is_nullable=std::nullopt, std::optional< bool > _is_binary=std::nullopt)
 Construct a column name info with a name, optional nullabilty, and no children. More...
 
bool operator== (column_name_info const &rhs) const
 Compares two column name info structs for equality. More...
 

Public Attributes

std::string name
 Column name.
 
std::optional< bool > is_nullable
 Column nullability.
 
std::optional< bool > is_binary
 Column is binary (i.e. not a list)
 
std::optional< int32_t > type_length
 Byte width of data (for fixed length data)
 
std::vector< column_name_infochildren
 Child column names.
 

Detailed Description

Detailed name (and optionally nullability) information for output columns.

The hierarchy of children matches the hierarchy of children in the output cudf columns.

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

Constructor & Destructor Documentation

◆ column_name_info()

cudf::io::column_name_info::column_name_info ( std::string  _name,
std::optional< bool >  _is_nullable = std::nullopt,
std::optional< bool >  _is_binary = std::nullopt 
)
inline

Construct a column name info with a name, optional nullabilty, and no children.

Parameters
_nameColumn name
_is_nullableTrue if column is nullable
_is_binaryTrue if column is binary data

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

Member Function Documentation

◆ operator==()

bool cudf::io::column_name_info::operator== ( column_name_info const &  rhs) const
inline

Compares two column name info structs for equality.

Parameters
rhscolumn name info struct to compare against
Returns
boolean indicating if this and rhs are equal

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


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