Struct PyBufferView 

#[repr(transparent)]
pub struct PyBufferView<T, Flag: PyBufferRequestType = PyBufferFlags<true, true, true, true, false, CONTIGUITY_UNDEFINED>>(PyUntypedBufferView<Flag>, PhantomData<[T]>);

Available on Py_3_11 or non-Py_LIMITED_API only.

A typed form of PyUntypedBufferView. Not constructible directly — use PyBufferView::with() or PyBufferView::with_flags().

Tuple Fields

0: PyUntypedBufferView<Flag>

1: PhantomData<[T]>

Implementations

impl<T: Element> PyBufferView<T>

pub fn with<R>( obj: &Bound<'_, PyAny>, f: impl FnOnce(&PyBufferView<T>) -> R, ) -> PyResult<R>

Acquire a typed buffer view with PyBufferRequest::full_ro() flags, validating that the buffer format is compatible with T.

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

where Flag: PyBufferRequestType + IncludesFormat,

Acquire a typed buffer view with the given flags.

The flags are passed to the exporter as requested. Format information must be available for type validation: PyBufferRequest::simple() and its writable variant imply unsigned bytes, while other requests must include .format().

impl<T: Element, Flag: PyBufferRequestType> PyBufferView<T, Flag>

pub fn as_slice_ptr(&self) -> Option<NonNull<[T]>>

Gets the buffer memory as a slice.

Returns None if the buffer is not C-contiguous.

Accessing the memory requires upholding the buffer memory access requirements.

pub fn as_fortran_slice_ptr(&self) -> Option<NonNull<[T]>>

Gets the buffer memory as a slice.

Returns None if the buffer is not Fortran-contiguous.

Accessing the memory requires upholding the buffer memory access requirements.

pub fn as_contiguous_slice_ptr(&self) -> NonNull<[T]>

where Flag: GuaranteesCContiguous,

Gets the buffer memory as a slice. The buffer is guaranteed C-contiguous.

Accessing the memory requires upholding the buffer memory access requirements.

pub fn as_fortran_contiguous_slice_ptr(&self) -> NonNull<[T]>

where Flag: GuaranteesFContiguous,

Gets the buffer memory as a slice pointer. The buffer is guaranteed Fortran-contiguous.

Accessing the memory requires upholding the buffer memory access requirements.

fn slice_pointer_internal(&self) -> NonNull<[T]>

Methods from Deref<Target = 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.

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.

Trait Implementations

impl<T, Flag: PyBufferRequestType> Debug for PyBufferView<T, Flag>

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

Formats the value using the given formatter.

impl<T, Flag: PyBufferRequestType> Deref for PyBufferView<T, Flag>

type Target = PyUntypedBufferView<Flag>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.