Struct PyUntypedBuffer 

pub struct PyUntypedBuffer(/* private fields */);

Allows access to the underlying buffer used by a python object such as bytes, bytearray or array.array.

Implementations

impl PyUntypedBuffer

pub fn get(obj: &Bound<'_, PyAny>) -> PyResult<Self>

Gets the underlying buffer from the specified python object.

pub fn into_typed<T: Element>(self) -> PyResult<PyBuffer<T>>

Returns a [PyBuffer] instance if the buffer can be interpreted as containing elements of type T.

pub fn as_typed<T: Element>(&self) -> PyResult<&PyBuffer<T>>

Non-owning equivalent of into_typed().

pub fn release(self, _py: Python<'_>)

Releases the buffer object, freeing the reference to the Python object which owns the buffer.

This will automatically be called on drop.

pub fn buf_ptr(&self) -> *mut c_void

Gets the pointer to the start of the buffer memory.

Warning: the buffer memory can be mutated by other code (including other Python functions, if the GIL is released, or other extension modules even if the GIL is held). You must either access memory atomically, or ensure there are no data races yourself. See this blog post for more details.

pub fn get_ptr(&self, indices: &[usize]) -> *mut c_void

Gets a pointer to the specified item.

If indices.len() < self.dimensions(), returns the start address of the sub-array at the specified dimension.

pub fn readonly(&self) -> bool

Gets whether the underlying buffer is read-only.

pub fn item_size(&self) -> usize

Gets the size of a single element, in bytes. Important exception: when requesting an unformatted buffer, item_size still has the value

pub fn item_count(&self) -> usize

Gets the total number of items.

pub fn len_bytes(&self) -> usize

item_size() * item_count(). For contiguous arrays, this is the length of the underlying memory block. For non-contiguous arrays, it is the length that the logical structure would have if it were copied to a contiguous representation.

pub fn dimensions(&self) -> usize

Gets the number of dimensions.

May be 0 to indicate a single scalar value.

pub fn shape(&self) -> &[usize]

Returns an array of length dimensions. shape()[i] is the length of the array in dimension number i.

May return None for single-dimensional arrays or scalar values (dimensions() <= 1); You can call item_count() to get the length of the single dimension.

Despite Python using an array of signed integers, the values are guaranteed to be non-negative. However, dimensions of length 0 are possible and might need special attention.

pub fn strides(&self) -> &[isize]

Returns an array that holds, for each dimension, the number of bytes to skip to get to the next element in the dimension.

Stride values can be any integer. For regular arrays, strides are usually positive, but a consumer MUST be able to handle the case strides[n] <= 0.

pub fn suboffsets(&self) -> Option<&[isize]>

An array of length ndim. If suboffsets[n] >= 0, the values stored along the nth dimension are pointers and the suboffset value dictates how many bytes to add to each pointer after de-referencing. A suboffset value that is negative indicates that no de-referencing should occur (striding in a contiguous memory block).

If all suboffsets are negative (i.e. no de-referencing is needed), then this field must be NULL (the default value).

pub fn format(&self) -> &CStr

A string in struct module style syntax describing the contents of a single item.

pub fn is_c_contiguous(&self) -> bool

Gets whether the buffer is contiguous in C-style order (last index varies fastest when visiting items in order of memory address).

pub fn is_fortran_contiguous(&self) -> bool

Gets whether the buffer is contiguous in Fortran-style order (first index varies fastest when visiting items in order of memory address).

Trait Implementations

impl Debug for PyUntypedBuffer

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

Formats the value using the given formatter.

impl Drop for PyUntypedBuffer

fn drop(&mut self)

Executes the destructor for this type.

impl Send for PyUntypedBuffer

impl Sync for PyUntypedBuffer