Struct PyBufferView 

pub struct PyBufferView<T, Flags: PyBufferFlagsType = PyBufferFlags<true, true, true>>(/* private fields */);

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

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 PyBufferFlags::full_ro() flags, validating that the buffer format is compatible with T.

pub fn with_flags<const FORMAT: bool, const SHAPE: bool, const STRIDE: bool, const WRITABLE: bool, const CONTIGUITY: u8, R>( obj: &Bound<'_, PyAny>, flags: PyBufferFlags<FORMAT, SHAPE, STRIDE, WRITABLE, CONTIGUITY>, f: impl FnOnce(&PyBufferView<T, PyBufferFlags<true, SHAPE, STRIDE, WRITABLE, CONTIGUITY>>) -> R, ) -> PyResult<R>

Acquire a typed buffer view with the given flags.

ffi::PyBUF_FORMAT is implicitly added for type validation.

impl<T: Element, Flags: PyBufferFlagsType> PyBufferView<T, Flags>

pub fn as_slice<'a>(&'a self, _py: Python<'a>) -> Option<&'a [ReadOnlyCell<T>]>

Gets the buffer memory as a slice.

Returns None if the buffer is not C-contiguous.

The returned slice uses type ReadOnlyCell<T> because it’s theoretically possible for any call into the Python runtime to modify the values in the slice.

pub fn as_mut_slice<'a>(&'a self, _py: Python<'a>) -> Option<&'a [Cell<T>]>

Gets the buffer memory as a mutable slice.

Returns None if the buffer is read-only or not C-contiguous.

The returned slice uses type Cell<T> because it’s theoretically possible for any call into the Python runtime to modify the values in the slice.

impl<T: Element, const FORMAT: bool, const SHAPE: bool, const STRIDE: bool, const WRITABLE: bool> PyBufferView<T, PyBufferFlags<FORMAT, SHAPE, STRIDE, WRITABLE, CONTIGUITY_C>>

pub fn as_contiguous_slice<'a>( &'a self, _py: Python<'a>, ) -> &'a [ReadOnlyCell<T>]

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

impl<T: Element, const FORMAT: bool, const SHAPE: bool, const STRIDE: bool> PyBufferView<T, PyBufferFlags<FORMAT, SHAPE, STRIDE, true, CONTIGUITY_C>>

pub fn as_contiguous_mut_slice<'a>(&'a self, _py: Python<'a>) -> &'a [Cell<T>]

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

impl<T: Element, const FORMAT: bool, const SHAPE: bool, const STRIDE: bool, const WRITABLE: bool> PyBufferView<T, PyBufferFlags<FORMAT, SHAPE, STRIDE, WRITABLE, CONTIGUITY_F>>

pub fn as_fortran_contiguous_slice<'a>( &'a self, _py: Python<'a>, ) -> &'a [ReadOnlyCell<T>]

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

impl<T: Element, const FORMAT: bool, const SHAPE: bool, const STRIDE: bool> PyBufferView<T, PyBufferFlags<FORMAT, SHAPE, STRIDE, true, CONTIGUITY_F>>

pub fn as_fortran_contiguous_mut_slice<'a>( &'a self, _py: Python<'a>, ) -> &'a [Cell<T>]

Gets the buffer memory as a mutable slice. The buffer is guaranteed Fortran-contiguous and writable.

Methods from Deref<Target = PyUntypedBufferView<Flags>>

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

Gets the pointer to the start of the buffer memory.

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.

May be 0 to indicate a single scalar value.

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

Returns the suboffsets array.

May return None even with PyBUF_INDIRECT if the exporter sets suboffsets to NULL.

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.

Trait Implementations

impl<T, Flags: PyBufferFlagsType> Debug for PyBufferView<T, Flags>

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

Formats the value using the given formatter.

impl<T, Flags: PyBufferFlagsType> Deref for PyBufferView<T, Flags>

type Target = PyUntypedBufferView<Flags>

The resulting type after dereferencing.

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

Dereferences the value.