Apache Arrow (C++)
A columnar in-memory analytics layer designed to accelerate big data.
Public Member Functions | List of all members
arrow::py::PyBuffer Class Reference

#include <arrow/python/common.h>

Inheritance diagram for arrow::py::PyBuffer:
arrow::Buffer

Public Member Functions

 PyBuffer (PyObject *obj)
 Note that the GIL must be held when calling the PyBuffer constructor. More...
 
 ~PyBuffer ()
 
- Public Member Functions inherited from arrow::Buffer
 Buffer (const uint8_t *data, int64_t size)
 Construct from buffer and size without copying memory. More...
 
 Buffer (const std::string &data)
 Construct from std::string without copying memory. More...
 
virtual ~Buffer ()=default
 
 Buffer (const std::shared_ptr< Buffer > &parent, const int64_t offset, const int64_t size)
 An offset into data that is owned by another buffer, but we want to be able to retain a valid pointer to it even after other shared_ptr's to the parent buffer have been destroyed. More...
 
bool is_mutable () const
 
bool Equals (const Buffer &other, int64_t nbytes) const
 Return true if both buffers are the same size and contain the same bytes up to the number of compared bytes. More...
 
bool Equals (const Buffer &other) const
 Return true if both buffers are the same size and contain the same bytes. More...
 
Status Copy (const int64_t start, const int64_t nbytes, MemoryPool *pool, std::shared_ptr< Buffer > *out) const
 Copy a section of the buffer into a new Buffer. More...
 
Status Copy (const int64_t start, const int64_t nbytes, std::shared_ptr< Buffer > *out) const
 Copy a section of the buffer using the default memory pool into a new Buffer. More...
 
int64_t capacity () const
 
const uint8_t * data () const
 
uint8_t * mutable_data ()
 
int64_t size () const
 
std::shared_ptr< Bufferparent () const
 

Additional Inherited Members

- Protected Attributes inherited from arrow::Buffer
bool is_mutable_
 
const uint8_t * data_
 
uint8_t * mutable_data_
 
int64_t size_
 
int64_t capacity_
 
std::shared_ptr< Bufferparent_
 

Constructor & Destructor Documentation

◆ PyBuffer()

arrow::py::PyBuffer::PyBuffer ( PyObject *  obj)
explicit

Note that the GIL must be held when calling the PyBuffer constructor.

While memoryview objects support multi-demensional buffers, PyBuffer only supports one-dimensional byte buffers.

◆ ~PyBuffer()

arrow::py::PyBuffer::~PyBuffer ( )

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