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

Source information for read interfaces. More...

#include <cudf/io/types.hpp>

Public Member Functions

 source_info ()=default
 Default constructor for the next-gen parquet reader.
 
 source_info (std::vector< std::string > file_paths)
 Construct a new source info object for multiple files. More...
 
 source_info (std::string file_path)
 Construct a new source info object for a single file. More...
 
 source_info (std::vector< filepath_source > sources)
 Construct a new source info object from filepath sources with optional known sizes. More...
 
template<typename T , CUDF_ENABLE_IF(is_byte_like_type< std::remove_cv_t< T >>()) >
 source_info (cudf::host_span< cudf::host_span< T >> const host_buffers)
 Construct a new source info object for multiple buffers in host memory. More...
 
template<typename T , CUDF_ENABLE_IF(is_byte_like_type< std::remove_cv_t< T >>()) >
 source_info (cudf::host_span< T > host_data)
 Construct a new source info object for a single buffer. More...
 
 source_info (cudf::host_span< cudf::device_span< std::byte const >> device_buffers)
 Construct a new source info object for multiple buffers in device memory. More...
 
 source_info (cudf::device_span< std::byte const > d_buffer)
 Construct a new source info object from a device buffer. More...
 
 source_info (std::vector< cudf::io::datasource * > const &sources)
 Construct a new source info object for multiple user-implemented sources. More...
 
 source_info (cudf::io::datasource *source)
 Construct a new source info object for a single user-implemented source. More...
 
auto type () const
 Get the type of the input. More...
 
auto const & filepath_sources () const
 Get the filepath sources of the input. More...
 
auto const & filepaths () const
 Get the filepaths of the input. More...
 
auto const & host_buffers () const
 Get the host buffers of the input. More...
 
auto const & device_buffers () const
 Get the device buffers of the input. More...
 
auto const & user_sources () const
 Get the user sources of the input. More...
 
auto num_sources () const
 Get the number of input sources. More...
 

Detailed Description

Source information for read interfaces.

Definition at line 306 of file types.hpp.

Constructor & Destructor Documentation

◆ source_info() [1/9]

cudf::io::source_info::source_info ( std::vector< std::string >  file_paths)
inlineexplicit

Construct a new source info object for multiple files.

Parameters
file_pathsInput files paths

Definition at line 317 of file types.hpp.

◆ source_info() [2/9]

cudf::io::source_info::source_info ( std::string  file_path)
inlineexplicit

Construct a new source info object for a single file.

Parameters
file_pathSingle input file

Definition at line 332 of file types.hpp.

◆ source_info() [3/9]

cudf::io::source_info::source_info ( std::vector< filepath_source sources)
inlineexplicit

Construct a new source info object from filepath sources with optional known sizes.

Parameters
sourcesInput filepath sources

Definition at line 342 of file types.hpp.

◆ source_info() [4/9]

template<typename T , CUDF_ENABLE_IF(is_byte_like_type< std::remove_cv_t< T >>()) >
cudf::io::source_info::source_info ( cudf::host_span< cudf::host_span< T >> const  host_buffers)
inlineexplicit

Construct a new source info object for multiple buffers in host memory.

Parameters
host_buffersInput buffers in host memory

Definition at line 354 of file types.hpp.

◆ source_info() [5/9]

template<typename T , CUDF_ENABLE_IF(is_byte_like_type< std::remove_cv_t< T >>()) >
cudf::io::source_info::source_info ( cudf::host_span< T >  host_data)
inlineexplicit

Construct a new source info object for a single buffer.

Parameters
host_dataInput buffer in host memory

Definition at line 377 of file types.hpp.

◆ source_info() [6/9]

cudf::io::source_info::source_info ( cudf::host_span< cudf::device_span< std::byte const >>  device_buffers)
inlineexplicit

Construct a new source info object for multiple buffers in device memory.

Parameters
device_buffersInput buffers in device memory

Definition at line 390 of file types.hpp.

◆ source_info() [7/9]

cudf::io::source_info::source_info ( cudf::device_span< std::byte const >  d_buffer)
inlineexplicit

Construct a new source info object from a device buffer.

Parameters
d_bufferInput buffer in device memory

Definition at line 402 of file types.hpp.

◆ source_info() [8/9]

cudf::io::source_info::source_info ( std::vector< cudf::io::datasource * > const &  sources)
inlineexplicit

Construct a new source info object for multiple user-implemented sources.

Parameters
sourcesUser-implemented input sources

Definition at line 412 of file types.hpp.

◆ source_info() [9/9]

cudf::io::source_info::source_info ( cudf::io::datasource source)
inlineexplicit

Construct a new source info object for a single user-implemented source.

Parameters
sourceSingle user-implemented Input source

Definition at line 422 of file types.hpp.

Member Function Documentation

◆ device_buffers()

auto const& cudf::io::source_info::device_buffers ( ) const
inline

Get the device buffers of the input.

Returns
The device buffers of the input

Definition at line 456 of file types.hpp.

◆ filepath_sources()

auto const& cudf::io::source_info::filepath_sources ( ) const
inline

Get the filepath sources of the input.

Returns
The filepath sources of the input

Definition at line 438 of file types.hpp.

◆ filepaths()

auto const& cudf::io::source_info::filepaths ( ) const
inline

Get the filepaths of the input.

Returns
The filepaths of the input

Definition at line 444 of file types.hpp.

◆ host_buffers()

auto const& cudf::io::source_info::host_buffers ( ) const
inline

Get the host buffers of the input.

Returns
The host buffers of the input

Definition at line 450 of file types.hpp.

◆ num_sources()

auto cudf::io::source_info::num_sources ( ) const
inline

Get the number of input sources.

Returns
The number of input sources

Definition at line 469 of file types.hpp.

◆ type()

auto cudf::io::source_info::type ( ) const
inline

Get the type of the input.

Returns
The type of the input

Definition at line 432 of file types.hpp.

◆ user_sources()

auto const& cudf::io::source_info::user_sources ( ) const
inline

Get the user sources of the input.

Returns
The user sources of the input

Definition at line 462 of file types.hpp.


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