pub struct PyRecordBatch(/* private fields */);
Expand description
A Python-facing Arrow record batch.
This is a wrapper around a RecordBatch.
Implementations§
Source§impl PyRecordBatch
impl PyRecordBatch
Sourcepub fn new(batch: RecordBatch) -> Self
pub fn new(batch: RecordBatch) -> Self
Construct a new PyRecordBatch from a RecordBatch.
Sourcepub fn from_arrow_pycapsule(
schema_capsule: &Bound<'_, PyCapsule>,
array_capsule: &Bound<'_, PyCapsule>,
) -> PyResult<Self>
pub fn from_arrow_pycapsule( schema_capsule: &Bound<'_, PyCapsule>, array_capsule: &Bound<'_, PyCapsule>, ) -> PyResult<Self>
Construct from raw Arrow capsules
Sourcepub fn into_inner(self) -> RecordBatch
pub fn into_inner(self) -> RecordBatch
Consume this, returning its internal RecordBatch.
Sourcepub fn to_arro3<'py>(&'py self, py: Python<'py>) -> PyResult<Bound<'py, PyAny>>
pub fn to_arro3<'py>(&'py self, py: Python<'py>) -> PyResult<Bound<'py, PyAny>>
Export this to a Python arro3.core.RecordBatch
.
Sourcepub fn into_arro3(self, py: Python<'_>) -> PyResult<Bound<'_, PyAny>>
pub fn into_arro3(self, py: Python<'_>) -> PyResult<Bound<'_, PyAny>>
Export this to a Python arro3.core.RecordBatch
.
Trait Implementations§
Source§impl AsRef<RecordBatch> for PyRecordBatch
impl AsRef<RecordBatch> for PyRecordBatch
Source§fn as_ref(&self) -> &RecordBatch
fn as_ref(&self) -> &RecordBatch
Converts this type into a shared reference of the (usually inferred) input type.
Source§impl Debug for PyRecordBatch
impl Debug for PyRecordBatch
Source§impl Display for PyRecordBatch
impl Display for PyRecordBatch
Source§impl From<PyRecordBatch> for Arro3RecordBatch
impl From<PyRecordBatch> for Arro3RecordBatch
Source§fn from(value: PyRecordBatch) -> Self
fn from(value: PyRecordBatch) -> Self
Converts to this type from the input type.
Source§impl From<PyRecordBatch> for RecordBatch
impl From<PyRecordBatch> for RecordBatch
Source§fn from(value: PyRecordBatch) -> Self
fn from(value: PyRecordBatch) -> Self
Converts to this type from the input type.
Source§impl From<RecordBatch> for PyRecordBatch
impl From<RecordBatch> for PyRecordBatch
Source§fn from(value: RecordBatch) -> Self
fn from(value: RecordBatch) -> Self
Converts to this type from the input type.
Source§impl<'a> FromPyObject<'a> for PyRecordBatch
impl<'a> FromPyObject<'a> for PyRecordBatch
Source§impl<'py> IntoPyObject<'py> for PyRecordBatch
impl<'py> IntoPyObject<'py> for PyRecordBatch
Source§type Target = PyRecordBatch
type Target = PyRecordBatch
The Python output type
Source§type Output = Bound<'py, <PyRecordBatch as IntoPyObject<'py>>::Target>
type Output = Bound<'py, <PyRecordBatch as IntoPyObject<'py>>::Target>
The smart pointer type to use. Read more
Source§fn into_pyobject(
self,
py: Python<'py>,
) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>
fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>
Performs the conversion.
Source§impl PyClass for PyRecordBatch
impl PyClass for PyRecordBatch
Source§impl PyClassBaseType for PyRecordBatch
impl PyClassBaseType for PyRecordBatch
type LayoutAsBase = PyClassObject<PyRecordBatch>
type BaseNativeType = <PyRecordBatch as PyClassImpl>::BaseNativeType
type Initializer = PyClassInitializer<PyRecordBatch>
type PyClassMutability = <PyRecordBatch as PyClassImpl>::PyClassMutability
Source§impl PyClassImpl for PyRecordBatch
impl PyClassImpl for PyRecordBatch
Source§const IS_BASETYPE: bool = true
const IS_BASETYPE: bool = true
#[pyclass(subclass)]
Source§const IS_SUBCLASS: bool = false
const IS_SUBCLASS: bool = false
#[pyclass(extends=…)]
Source§const IS_MAPPING: bool = false
const IS_MAPPING: bool = false
#[pyclass(mapping)]
Source§const IS_SEQUENCE: bool = false
const IS_SEQUENCE: bool = false
#[pyclass(sequence)]
Source§const IS_IMMUTABLE_TYPE: bool = false
const IS_IMMUTABLE_TYPE: bool = false
#[pyclass(immutable_type)]
Source§const RAW_DOC: &'static CStr = /// A Python-facing Arrow record batch.
///
/// This is a wrapper around a [RecordBatch].
const RAW_DOC: &'static CStr = /// A Python-facing Arrow record batch. /// /// This is a wrapper around a [RecordBatch].
Docstring for the class provided on the struct or enum. Read more
Source§const DOC: &'static CStr
const DOC: &'static CStr
Fully rendered class doc, including the
text_signature
if a constructor is defined. Read moreSource§type ThreadChecker = SendablePyClass<PyRecordBatch>
type ThreadChecker = SendablePyClass<PyRecordBatch>
This handles following two situations: Read more
Source§type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::ImmutableChild
type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::ImmutableChild
Immutable or mutable
Source§type BaseNativeType = PyAny
type BaseNativeType = PyAny
The closest native ancestor. This is
PyAny
by default, and when you declare
#[pyclass(extends=PyDict)]
, it’s PyDict
.fn items_iter() -> PyClassItemsIter
fn lazy_type_object() -> &'static LazyTypeObject<Self>
fn dict_offset() -> Option<isize>
fn weaklist_offset() -> Option<isize>
Source§impl PyClassNewTextSignature for PyRecordBatch
impl PyClassNewTextSignature for PyRecordBatch
const TEXT_SIGNATURE: &'static str = "(data, *, schema=None, metadata=None)"
Source§impl PyClass__eq__SlotFragment<PyRecordBatch> for PyClassImplCollector<PyRecordBatch>
impl PyClass__eq__SlotFragment<PyRecordBatch> for PyClassImplCollector<PyRecordBatch>
Source§impl<'a, 'holder, 'py> PyFunctionArgument<'a, 'holder, 'py, false> for &'holder PyRecordBatch
impl<'a, 'holder, 'py> PyFunctionArgument<'a, 'holder, 'py, false> for &'holder PyRecordBatch
Source§impl PyMethods<PyRecordBatch> for PyClassImplCollector<PyRecordBatch>
impl PyMethods<PyRecordBatch> for PyClassImplCollector<PyRecordBatch>
fn py_methods(self) -> &'static PyClassItems
Source§impl PyTypeInfo for PyRecordBatch
impl PyTypeInfo for PyRecordBatch
Source§fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
Returns the PyTypeObject instance for this type.
Source§fn type_object(py: Python<'_>) -> Bound<'_, PyType>
fn type_object(py: Python<'_>) -> Bound<'_, PyType>
Returns the safe abstraction over the type object.
impl DerefToPyAny for PyRecordBatch
Auto Trait Implementations§
impl Freeze for PyRecordBatch
impl !RefUnwindSafe for PyRecordBatch
impl Send for PyRecordBatch
impl Sync for PyRecordBatch
impl Unpin for PyRecordBatch
impl !UnwindSafe for PyRecordBatch
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<'py, T> FromPyObjectBound<'_, 'py> for Twhere
T: FromPyObject<'py>,
impl<'py, T> FromPyObjectBound<'_, 'py> for Twhere
T: FromPyObject<'py>,
Source§impl<'py, T> IntoPyObjectExt<'py> for Twhere
T: IntoPyObject<'py>,
impl<'py, T> IntoPyObjectExt<'py> for Twhere
T: IntoPyObject<'py>,
Source§fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>
fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>
Converts
self
into an owned Python object, dropping type information.