Public Member Functions | Static Public Member Functions | List of all members
cudf::io::datasource::buffer Class Referenceabstract

Interface class for buffers that the datasource returns to the caller. More...

#include <datasource.hpp>

Inheritance diagram for cudf::io::datasource::buffer:
cudf::io::datasource::non_owning_buffer cudf::io::datasource::owning_buffer< Container >

Public Member Functions

virtual size_t size () const =0
 Returns the buffer size in bytes. More...
 
virtual uint8_t const * data () const =0
 Returns the address of the data in the buffer. More...
 
virtual ~buffer ()
 Base class destructor.
 

Static Public Member Functions

template<typename Container >
static std::unique_ptr< buffercreate (Container &&data_owner)
 Factory to construct a datasource buffer object from a container. More...
 

Detailed Description

Interface class for buffers that the datasource returns to the caller.

Provides a basic interface to return the data address and size.

Definition at line 51 of file datasource.hpp.

Member Function Documentation

◆ create()

template<typename Container >
static std::unique_ptr<buffer> cudf::io::datasource::buffer::create ( Container &&  data_owner)
inlinestatic

Factory to construct a datasource buffer object from a container.

Template Parameters
ContainerType of the container to construct the buffer from
Parameters
data_ownerThe container to construct the buffer from (ownership is transferred)
Returns
Constructed buffer object

Definition at line 80 of file datasource.hpp.

◆ data()

virtual uint8_t const* cudf::io::datasource::buffer::data ( ) const
pure virtual

Returns the address of the data in the buffer.

Returns
Address of the data in the buffer

Implemented in cudf::io::datasource::owning_buffer< Container >, and cudf::io::datasource::non_owning_buffer.

◆ size()

virtual size_t cudf::io::datasource::buffer::size ( ) const
pure virtual

Returns the buffer size in bytes.

Returns
Buffer size in bytes

Implemented in cudf::io::datasource::owning_buffer< Container >, and cudf::io::datasource::non_owning_buffer.


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