Skip to content

Commit

Permalink
Add doxygen comment to set_serialization_callbacks
Browse files Browse the repository at this point in the history
Change-Id: If9ac54f494495186743b0a6929ea193ca5048ed0
  • Loading branch information
wesm committed Aug 19, 2017
1 parent a9522c5 commit 8a42f30
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions cpp/src/arrow/python/python_to_arrow.h
Original file line number Diff line number Diff line change
Expand Up @@ -39,15 +39,22 @@ class OutputStream;

namespace py {

ARROW_EXPORT
void set_serialization_callbacks(PyObject* serialize_callback,
PyObject* deserialize_callback);

struct ARROW_EXPORT SerializedPyObject {
std::shared_ptr<RecordBatch> batch;
std::vector<std::shared_ptr<Tensor>> tensors;
};

/// \brief Register callback functions to perform conversions to or from other
/// Python representations en route to/from deserialization
///
/// \param[in] serialize_callback a Python callable
/// \param[in] deserialize_callback a Python callable
///
/// Analogous to Python custom picklers / unpicklers
ARROW_EXPORT
void set_serialization_callbacks(PyObject* serialize_callback,
PyObject* deserialize_callback);

/// \brief Serialize Python sequence as a RecordBatch plus
/// \param[in] sequence a Python sequence object to serialize to Arrow data
/// structures
Expand Down

0 comments on commit 8a42f30

Please sign in to comment.