Struct DLPackCapsule 

pub struct DLPackCapsule { /* private fields */ }

Python class wrapping a DLPack-compatible tensor.

Exposes __dlpack__ and __dlpack_device__ so that any DLPack-aware framework (PyTorch, JAX, CuPy, etc.) can consume the tensor without copying.

Implementations

impl DLPackCapsule

pub fn new(shape: Vec<i64>, dtype_code: u8, dtype_bits: u8) -> Self

Create a new zero-filled DLPack capsule.

Arguments

• shape – tensor dimensions
• dtype_code – element type code (0=int, 1=uint, 2=float, 3=bfloat)
• dtype_bits – element bit-width (e.g. 32 or 64)

pub fn dlpack_device(&self) -> (i32, i32)

Return (device_type_int, device_id) — the __dlpack_device__ protocol.

pub fn dlpack<'py>(&self, py: Python<'py>) -> PyResult<Bound<'py, PyCapsule>>

Return a Python PyCapsule named "dltensor" — the __dlpack__ protocol.

The capsule contains a DLManagedTensor with a destructor that frees the heap allocation created here.

Safety

The capsule pointer is valid as long as the capsule is live. The deleter registered in DLManagedTensor ensures the allocation is freed.

pub fn shape(&self) -> Vec<i64>

Return the shape of this tensor.

pub fn ndim(&self) -> usize

Return the number of dimensions.

pub fn dtype_code(&self) -> u8

Return the dtype type-code (0=int, 1=uint, 2=float, 3=bfloat).

pub fn dtype_bits(&self) -> u8

Return the number of bits per element.

Trait Implementations

impl<'py> IntoPyObject<'py> for DLPackCapsule

type Target = DLPackCapsule

The Python output type

type Output = Bound<'py, <DLPackCapsule as IntoPyObject<'py>>::Target>

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>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PyClass for DLPackCapsule

const NAME: &str = "DLPackCapsule"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for DLPackCapsule

const MODULE: Option<&str> = ::core::option::Option::None

Module which the class will be associated with.

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)]

const RAW_DOC: &'static CStr = /// Python class wrapping a DLPack-compatible tensor. /// /// Exposes `__dlpack__` and `__dlpack_device__` so that any DLPack-aware /// framework (PyTorch, JAX, CuPy, etc.) can consume the tensor without copying.

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 = <<DLPackCapsule as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<DLPackCapsule>

Description of how this class is laid out in memory

type BaseType = PyAny

Base class

type ThreadChecker = NoopThreadChecker

This handles following two situations:

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 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 DLPackCapsule

const TEXT_SIGNATURE: &'static str = "(shape, dtype_code, dtype_bits)"

impl PyMethods<DLPackCapsule> for PyClassImplCollector<DLPackCapsule>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for DLPackCapsule

const NAME: &str = <Self as ::pyo3::PyClass>::NAME

👎Deprecated since 0.28.0:

prefer using ::type_object(py).name() to get the correct runtime value

Class name.

const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE

👎Deprecated since 0.28.0:

prefer using ::type_object(py).module() to get the correct runtime value

Module name, if any.

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 DerefToPyAny for DLPackCapsule

impl ExtractPyClassWithClone for DLPackCapsule