cudf::io::sink_info Struct Reference

Destination information for write interfaces. More...

#include <types.hpp>

Public Member Functions
	sink_info (size_t num_sinks)
	Construct a new sink info object. More...
	sink_info (std::vector< std::string > const &file_paths)
	Construct a new sink info object for multiple files. More...
	sink_info (std::string const &file_path)
	Construct a new sink info object for a single file. More...
	sink_info (std::vector< std::vector< char > * > const &buffers)
	Construct a new sink info object for multiple host buffers. More...
	sink_info (std::vector< char > *buffer)
	Construct a new sink info object for a single host buffer. More...
	sink_info (std::vector< cudf::io::data_sink * > const &user_sinks)
	Construct a new sink info object for multiple user-implemented sinks. More...
	sink_info (class cudf::io::data_sink *user_sink)
	Construct a new sink info object for a single user-implemented sink. More...
auto	type () const
	Get the type of the input. More...
auto	num_sinks () const
	Get the number of sinks. More...
auto const &	filepaths () const
	Get the filepaths of the input. More...
auto const &	buffers () const
	Get the host buffers of the input. More...
auto const &	user_sinks () const
	Get the user sinks of the input. More...

Detailed Description

Destination information for write interfaces.

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

Constructor & Destructor Documentation

sink_info() [1/7]

cudf::io::sink_info::sink_info ( size_t  num_sinks )

inline

Construct a new sink info object.

Parameters

num_sinks

Number of sinks

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

sink_info() [2/7]

cudf::io::sink_info::sink_info ( std::vector< std::string > const &  file_paths )

inlineexplicit

Construct a new sink info object for multiple files.

Parameters

file_paths

Output files paths

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

sink_info() [3/7]

cudf::io::sink_info::sink_info ( std::string const &  file_path )

inlineexplicit

Construct a new sink info object for a single file.

Parameters

file_path

Single output file path

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

sink_info() [4/7]

cudf::io::sink_info::sink_info ( std::vector< std::vector< char > * > const &  buffers )

inlineexplicit

Construct a new sink info object for multiple host buffers.

Parameters

buffers

Output host buffers

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

sink_info() [5/7]

cudf::io::sink_info::sink_info ( std::vector< char > *  buffer )

inlineexplicit

Construct a new sink info object for a single host buffer.

Parameters

buffer

Single output host buffer

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

sink_info() [6/7]

cudf::io::sink_info::sink_info ( std::vector< cudf::io::data_sink * > const &  user_sinks )

inlineexplicit

Construct a new sink info object for multiple user-implemented sinks.

Parameters

user_sinks

Output user-implemented sinks

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

sink_info() [7/7]

cudf::io::sink_info::sink_info ( class cudf::io::data_sink *  user_sink )

inlineexplicit

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

Parameters

user_sink

Single output user-implemented sink

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

Member Function Documentation

buffers()

auto const& cudf::io::sink_info::buffers ( ) const

inline

Get the host buffers of the input.

Returns

The host buffers of the input

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

filepaths()

auto const& cudf::io::sink_info::filepaths ( ) const

inline

Get the filepaths of the input.

Returns

The filepaths of the input

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

num_sinks()

auto cudf::io::sink_info::num_sinks ( ) const

inline

Get the number of sinks.

Returns

The number of sinks

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

type()

auto cudf::io::sink_info::type ( ) const

inline

Get the type of the input.

Returns

The type of the input

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

user_sinks()

auto const& cudf::io::sink_info::user_sinks ( ) const

inline

Get the user sinks of the input.

Returns

The user sinks of the input

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

---

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

• io/types.hpp