Struct PyUntypedBufferView 

#[repr(transparent)]
pub struct PyUntypedBufferView<Flag: PyBufferRequestType = PyBufferFlags<false, false, false, false, false, CONTIGUITY_UNDEFINED>> {
    raw: Py_buffer,
    _flags: PhantomData<Flag>,
    _pin: PhantomPinned,
}

Available on Py_3_11 or non-Py_LIMITED_API only.

Stack-allocated untyped buffer view.

Unlike PyUntypedBuffer which heap-allocates, this places the Py_buffer on the stack. The scoped closure API ensures the buffer cannot be moved.

Use with_flags() with a PyBufferRequest value to acquire a view. The available accessors depend on the flags used.

Fields

raw: Py_buffer

_flags: PhantomData<Flag>

_pin: PhantomPinned

Implementations

impl<Flag: PyBufferRequestType> PyUntypedBufferView<Flag>

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

Gets the pointer to the start of the buffer memory.

See PyUntypedBuffer::buf_ptr() for considerations about how to safely read and write data through this pointer.

pub fn obj<'py>(&self, py: Python<'py>) -> Option<&Bound<'py, PyAny>>

Returns the Python object that owns the buffer data.

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.

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.

pub fn dimensions(&self) -> usize

Gets the number of dimensions.

Always at least 1. Scalar buffers are rejected during acquisition.

pub fn is_c_contiguous(&self) -> bool

Gets whether the buffer is contiguous in C-style order.

pub fn is_fortran_contiguous(&self) -> bool

Gets whether the buffer is contiguous in Fortran-style order.

impl<Flag: PyBufferRequestType> PyUntypedBufferView<Flag>

pub fn format(&self) -> &CStr

where Flag: IncludesFormat,

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

pub fn as_typed<T: Element>(&self) -> PyResult<&PyBufferView<T, Flag>>

where Flag: IncludesFormat,

Attempt to interpret this untyped view as containing elements of type T.

fn ensure_compatible_with<T: Element>(&self) -> PyResult<()>

where Flag: IncludesFormat,

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

where Flag: IncludesShape,

Returns the shape array. shape[i] is the length of dimension i.

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]

where Flag: IncludesStrides,

Returns the strides array.

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

where Flag: IncludesSuboffsets,

Returns the suboffsets array.

May return None even when suboffsets were requested if the exporter sets suboffsets to NULL.

impl PyUntypedBufferView

pub fn with_flags<Flag: PyBufferRequestType, R>( obj: &Bound<'_, PyAny>, flags: PyBufferRequest<Flag>, f: impl FnOnce(&PyUntypedBufferView<Flag>) -> R, ) -> PyResult<R>

Acquire a buffer view with the given flags, pass it to f, then release the buffer.

Use PyBufferRequest::simple() or one of the compound-request constructors such as PyBufferRequest::full_ro() to acquire a view.

The requested flags constrain what exporters may return. For example, without shape information only 1-dimensional buffers are permitted.

Trait Implementations

impl<Flag: PyBufferRequestType> Debug for PyUntypedBufferView<Flag>

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

Formats the value using the given formatter.

impl<Flag: PyBufferRequestType> Drop for PyUntypedBufferView<Flag>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.