cudf::io::source_info Struct Reference

Source information for read interfaces. More...

#include <types.hpp>

Public Member Functions
	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...
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 &	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...

Detailed Description

Source information for read interfaces.

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

Constructor & Destructor Documentation

source_info() [1/8]

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

inlineexplicit

Construct a new source info object for multiple files.

Parameters

file_paths

Input files paths

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

source_info() [2/8]

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

inlineexplicit

Construct a new source info object for a single file.

Parameters

file_path

Single input file

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

source_info() [3/8]

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_buffers

Input buffers in host memory

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

source_info() [4/8]

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_data

Input buffer in host memory

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

source_info() [5/8]

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_buffers

Input buffers in device memory

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

source_info() [6/8]

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_buffer

Input buffer in device memory

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

source_info() [7/8]

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

sources

User-implemented input sources

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

source_info() [8/8]

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

inlineexplicit

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

Parameters

source

Single user-implemented Input source

Definition at line 421 of file io/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 449 of file io/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 437 of file io/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 443 of file io/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 431 of file io/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 455 of file io/types.hpp.

---

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

• io/types.hpp