Skip to main content

PyBufferRequest

pyo3::buffer

Struct PyBufferRequest 

Source 
pub struct PyBufferRequest<Flag: PyBufferRequestType = PyBufferFlags<false, false, false, false, false, CONTIGUITY_UNDEFINED>>(c_int, PhantomData<Flag>);
Available on Py_3_11 or non-Py_LIMITED_API only.
Expand description

Type-safe buffer request. The state parameter is intentionally hidden behind this wrapper so the internal encoding can evolve.

The requested flags constrain what exporters are allowed to return. For example, without shape information, only 1-dimensional buffers are permitted, and accessors for unrequested metadata are unavailable on the typed view.

Tuple Fields§

§0: c_int§1: PhantomData<Flag>

Implementations§

Source§

impl<Flag: PyBufferRequestType> PyBufferRequest<Flag>

Source

pub const fn format(self) -> PyBufferRequest<Flag::WithFormat>
where Flag: CanRequestFormat,

Request format information.

Source

pub const fn nd(self) -> PyBufferRequest<Flag::WithShape>
where Flag: CanRequestShape,

Request shape information.

Source

pub const fn strides(self) -> PyBufferRequest<Flag::WithStrides>
where Flag: CanRequestStrides,

Request strides information. Implies shape.

Source

pub const fn indirect(self) -> PyBufferRequest<Flag::WithIndirect>
where Flag: CanRequestIndirect,

Request suboffsets (indirect). Implies shape and strides.

Source

pub const fn writable(self) -> PyBufferRequest<Flag::WithWritable>
where Flag: CanRequestWritable,

Request a writable buffer.

Source

pub const fn c_contiguous(self) -> PyBufferRequest<Flag::WithCContiguous>
where Flag: CanRequestContiguity,

Require C-contiguous layout. Implies shape and strides.

Source

pub const fn f_contiguous(self) -> PyBufferRequest<Flag::WithFContiguous>
where Flag: CanRequestContiguity,

Require Fortran-contiguous layout. Implies shape and strides.

Source

pub const fn any_contiguous(self) -> PyBufferRequest<Flag::WithAnyContiguous>
where Flag: CanRequestContiguity,

Require contiguous layout (C or Fortran). Implies shape and strides.

The specific contiguity order is not known at compile time, so this does not unlock non-Option slice accessors.

Source§

impl PyBufferRequest

Source

pub const fn simple() -> PyBufferRequest<RequestFlags<false, false, false, false, false, CONTIGUITY_UNDEFINED>>

Create a base buffer request. Chain builder methods to add flags.

Source

pub const fn full() -> PyBufferRequest<RequestFlags<true, true, true, true, true, CONTIGUITY_UNDEFINED>>

Create a writable request for all buffer information including suboffsets.

Source

pub const fn full_ro() -> PyBufferRequest<RequestFlags<true, true, true, true, false, CONTIGUITY_UNDEFINED>>

Create a read-only request for all buffer information including suboffsets.

Source

pub const fn records() -> PyBufferRequest<RequestFlags<true, true, true, false, true, CONTIGUITY_UNDEFINED>>

Create a writable request for format, shape, and strides.

Source

pub const fn records_ro() -> PyBufferRequest<RequestFlags<true, true, true, false, false, CONTIGUITY_UNDEFINED>>

Create a read-only request for format, shape, and strides.

Source

pub const fn strided() -> PyBufferRequest<RequestFlags<false, true, true, false, true, CONTIGUITY_UNDEFINED>>

Create a writable request for shape and strides.

Source

pub const fn strided_ro() -> PyBufferRequest<RequestFlags<false, true, true, false, false, CONTIGUITY_UNDEFINED>>

Create a read-only request for shape and strides.

Source

pub const fn contig() -> PyBufferRequest<RequestFlags<false, true, false, false, true, CONTIGUITY_C>>

Create a writable C-contiguous request.

Source

pub const fn contig_ro() -> PyBufferRequest<RequestFlags<false, true, false, false, false, CONTIGUITY_C>>

Create a read-only C-contiguous request.

Auto Trait Implementations§

§

impl<Flag> Freeze for PyBufferRequest<Flag>
where PhantomData<Flag>: Freeze,

§

impl<Flag> RefUnwindSafe for PyBufferRequest<Flag>
where PhantomData<Flag>: RefUnwindSafe,

§

impl<Flag> Send for PyBufferRequest<Flag>
where PhantomData<Flag>: Send,

§

impl<Flag> Sync for PyBufferRequest<Flag>
where PhantomData<Flag>: Sync,

§

impl<Flag> Unpin for PyBufferRequest<Flag>
where PhantomData<Flag>: Unpin,

§

impl<Flag> UnsafeUnpin for PyBufferRequest<Flag>
where PhantomData<Flag>: UnsafeUnpin,

§

impl<Flag> UnwindSafe for PyBufferRequest<Flag>
where PhantomData<Flag>: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> SizeHint for T
where T: ?Sized,

Source§

default fn lower_bound(&self) -> usize

🔬This is a nightly-only experimental API. (core_io_internals)
Returns a lower bound on the number of elements this container-like item contains. For example, an array [u8; 12] could return any value between 0 and 12 inclusively as a correct implementation. Read more
Source§

default fn upper_bound(&self) -> Option<usize>

🔬This is a nightly-only experimental API. (core_io_internals)
Returns an upper bound on the number of elements this container-like item contains if it can be determined, otherwise None. Read more
Source§

final fn size_hint(&self) -> (usize, Option<usize>)

🔬This is a nightly-only experimental API. (core_io_internals)
Returns an estimate for the number of elements this container like type contains. Read more
Source§

impl<T> SizedTypeProperties for T

Source§

#[doc(hidden)]
const SIZE: usize = _

🔬This is a nightly-only experimental API. (sized_type_properties)
Source§

#[doc(hidden)]
const ALIGN: usize = _

🔬This is a nightly-only experimental API. (sized_type_properties)
Source§

#[doc(hidden)]
const ALIGNMENT: Alignment = _

🔬This is a nightly-only experimental API. (ptr_alignment_type)
Source§

#[doc(hidden)]
const IS_ZST: bool = _

🔬This is a nightly-only experimental API. (sized_type_properties)
true if this type requires no storage. false if its size is greater than zero. Read more
Source§

#[doc(hidden)]
const LAYOUT: Layout = _

🔬This is a nightly-only experimental API. (sized_type_properties)
Source§

#[doc(hidden)]
const MAX_SLICE_LEN: usize = _

🔬This is a nightly-only experimental API. (sized_type_properties)
The largest safe length for a [Self]. Read more
Source§

impl<T> SomeWrap<T> for T

Source§

fn wrap(self) -> Option<T>

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> Ungil for T
where T: Send,

⚠️ Internal Docs ⚠️ Not Public API 👉 Official Docs Here