Struct CustomData 

pub struct CustomData {
    pub data: Arc<dyn CustomDataTrait>,
    pub data_type: DataType,
}

A wrapper for custom data including its data type.

The data field holds an Arc to a CustomDataTrait implementation, enabling cheap cloning when passing to Python (Arc clone is O(1)). Custom data is always Rust-defined (optionally with PyO3 bindings).

Fields

data: Arc<dyn CustomDataTrait>

The actual data object implementing CustomDataTrait.

data_type: DataType

The data type metadata.

Implementations

impl CustomData

pub fn from_arc(arc: Arc<dyn CustomDataTrait>) -> Self

Creates a new CustomData instance from an Arc’d CustomDataTrait, deriving the data type from the inner type name.

pub fn new(data: Arc<dyn CustomDataTrait>, data_type: DataType) -> Self

Creates a new CustomData instance with explicit data type metadata.

Use this when the data type must come from external metadata (e.g. Parquet), rather than being derived from the inner type name.

impl CustomData

pub fn from_json_bytes(bytes: &[u8]) -> Result<Self, Error>

Deserializes CustomData from JSON bytes (full CustomData format with type and data_type).

Errors

Returns an error if the bytes are not valid JSON or do not represent CustomData.

Trait Implementations

impl Clone for CustomData

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CustomData

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl DerefToPyAny for CustomData

impl FromDataBatch for CustomData

fn from_batch(batch: DataBatch) -> Result<Vec<Self>>

Unwraps a typed batch into owned values.

impl<'a, 'py> FromPyObject<'a, 'py> for CustomData

where Self: Clone,

type Error = PyClassGuardError<'a, 'py>

The type returned in the event of a conversion error.

fn extract( obj: Borrowed<'a, 'py, PyAny>, ) -> Result<Self, <Self as FromPyObject<'a, 'py>>::Error>

Extracts Self from the bound smart pointer obj.

impl HasTsInit for CustomData

fn ts_init(&self) -> UnixNanos

Returns the UNIX timestamp (nanoseconds) when the instance was created.

impl IntoDataBatch for CustomData

fn into_batch(data: Vec<Self>) -> DataBatch

Wraps owned typed values in their DataBatch variant.

impl<'py> IntoPyObject<'py> for CustomData

type Target = CustomData

The Python output type

type Output = Bound<'py, CustomData>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject(self, py: Python<'py>) -> PyResult<Bound<'py, Self>>

Performs the conversion.

impl PartialEq for CustomData

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PyClass for CustomData

const NAME: &str = "CustomData"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for CustomData

const MODULE: Option<&str>

Module which the class will be associated with.

const RAW_DOC: &'static CStr = /// A wrapper for custom data including its data type. /// /// The `data` field holds an [`Arc`] to a [`CustomDataTrait`] implementation, /// enabling cheap cloning when passing to Python (Arc clone is O(1)). /// Custom data is always Rust-defined (optionally with PyO3 bindings).

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type Layout = <<CustomData as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<CustomData>

Description of how this class is laid out in memory

type BaseType = PyAny

Base class

type ThreadChecker = NoopThreadChecker

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForCustomData

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

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 __traverse__(&self, visit: PyVisit<'_>) -> Result<(), PyTraverseError>

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

fn dict_offset() -> Option<PyObjectOffset>

Used to provide the dictoffset slot (equivalent to tp_dictoffset)

fn weaklist_offset() -> Option<PyObjectOffset>

Used to provide the weaklistoffset slot (equivalent to tp_weaklistoffset

impl PyClassNewTextSignature for CustomData

const TEXT_SIGNATURE: &'static str = "(data_type, data)"

impl PyStubType for CustomData

fn type_output() -> TypeInfo

The type to be used in the output signature, i.e. return type of the Python function or methods.

fn type_input() -> TypeInfo

The type to be used in the input signature, i.e. the arguments of the Python function or methods.

impl PyTypeInfo for CustomData

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl Serialize for CustomData

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.