Skip to main content

PyBufferFlags

pyo3::buffer::flags

Struct PyBufferFlags 

Source 
pub struct PyBufferFlags<const FORMAT: bool, const SHAPE: bool, const STRIDE: bool, const INDIRECT: bool, const WRITABLE: bool, const CONTIGUITY: u8>;
Available on Py_3_11 or non-Py_LIMITED_API only.

Trait Implementations§

Source§

impl<const FORMAT: bool, const SHAPE: bool, const STRIDE: bool, const INDIRECT: bool, const WRITABLE: bool> CanRequestContiguity for PyBufferFlags<FORMAT, SHAPE, STRIDE, INDIRECT, WRITABLE, { CONTIGUITY_UNDEFINED }>

Source§

impl<const SHAPE: bool, const STRIDE: bool, const INDIRECT: bool, const WRITABLE: bool, const CONTIGUITY: u8> CanRequestFormat for PyBufferFlags<false, SHAPE, STRIDE, INDIRECT, WRITABLE, CONTIGUITY>

Source§

impl<const FORMAT: bool, const SHAPE: bool, const STRIDE: bool, const WRITABLE: bool> CanRequestIndirect for PyBufferFlags<FORMAT, SHAPE, STRIDE, false, WRITABLE, { CONTIGUITY_UNDEFINED }>

Source§

impl<const FORMAT: bool, const STRIDE: bool, const INDIRECT: bool, const WRITABLE: bool, const CONTIGUITY: u8> CanRequestShape for PyBufferFlags<FORMAT, false, STRIDE, INDIRECT, WRITABLE, CONTIGUITY>

Source§

impl<const FORMAT: bool, const SHAPE: bool, const INDIRECT: bool, const WRITABLE: bool, const CONTIGUITY: u8> CanRequestStrides for PyBufferFlags<FORMAT, SHAPE, false, INDIRECT, WRITABLE, CONTIGUITY>

Source§

impl<const FORMAT: bool, const SHAPE: bool, const STRIDE: bool, const INDIRECT: bool, const CONTIGUITY: u8> CanRequestWritable for PyBufferFlags<FORMAT, SHAPE, STRIDE, INDIRECT, false, CONTIGUITY>

Source§

impl<const FORMAT: bool, const SHAPE: bool, const STRIDE: bool, const INDIRECT: bool, const WRITABLE: bool> GuaranteesCContiguous for PyBufferFlags<FORMAT, SHAPE, STRIDE, INDIRECT, WRITABLE, { CONTIGUITY_C }>

Source§

impl<const FORMAT: bool, const SHAPE: bool, const STRIDE: bool, const INDIRECT: bool, const WRITABLE: bool> GuaranteesFContiguous for PyBufferFlags<FORMAT, SHAPE, STRIDE, INDIRECT, WRITABLE, { CONTIGUITY_F }>

Source§

impl<const SHAPE: bool, const STRIDE: bool, const INDIRECT: bool, const WRITABLE: bool, const CONTIGUITY: u8> IncludesFormat for PyBufferFlags<true, SHAPE, STRIDE, INDIRECT, WRITABLE, CONTIGUITY>

Source§

const ASSUME_U8: bool = false

Source§

impl<const WRITABLE: bool> IncludesFormat for PyBufferFlags<false, false, false, false, WRITABLE, { CONTIGUITY_UNDEFINED }>

Source§

const ASSUME_U8: bool = true

Source§

impl<const FORMAT: bool, const STRIDE: bool, const INDIRECT: bool, const WRITABLE: bool, const CONTIGUITY: u8> IncludesShape for PyBufferFlags<FORMAT, true, STRIDE, INDIRECT, WRITABLE, CONTIGUITY>

Source§

impl<const FORMAT: bool, const SHAPE: bool, const INDIRECT: bool, const WRITABLE: bool, const CONTIGUITY: u8> IncludesStrides for PyBufferFlags<FORMAT, SHAPE, true, INDIRECT, WRITABLE, CONTIGUITY>

Source§

impl<const FORMAT: bool, const SHAPE: bool, const STRIDE: bool, const WRITABLE: bool, const CONTIGUITY: u8> IncludesSuboffsets for PyBufferFlags<FORMAT, SHAPE, STRIDE, true, WRITABLE, CONTIGUITY>

Source§

impl<const FORMAT: bool, const SHAPE: bool, const STRIDE: bool, const INDIRECT: bool, const WRITABLE: bool, const CONTIGUITY_REQ: u8> PyBufferRequestType for PyBufferFlags<FORMAT, SHAPE, STRIDE, INDIRECT, WRITABLE, CONTIGUITY_REQ>

Source§

const IS_SIMPLE: bool

Whether this is a simple request, which treats the buffer as unsigned bytes.
Source§

const CONTIGUITY: PyBufferContiguity

The contiguity requirement encoded by these flags.
Source§

const WRITABLE: bool = WRITABLE

Whether these flags require a writable buffer.
Source§

type WithFormat = PyBufferFlags<true, SHAPE, STRIDE, INDIRECT, WRITABLE, CONTIGUITY_REQ>

The state after requesting format information.
Source§

type WithShape = PyBufferFlags<FORMAT, true, STRIDE, INDIRECT, WRITABLE, CONTIGUITY_REQ>

The state after requesting shape information.
Source§

type WithStrides = PyBufferFlags<FORMAT, true, true, INDIRECT, WRITABLE, CONTIGUITY_REQ>

The state after requesting strides information.
Source§

type WithIndirect = PyBufferFlags<FORMAT, true, true, true, WRITABLE, CONTIGUITY_UNDEFINED>

The state after requesting indirect / suboffset information.
Source§

type WithWritable = PyBufferFlags<FORMAT, SHAPE, STRIDE, INDIRECT, true, CONTIGUITY_REQ>

The state after requesting writability.
Source§

type WithCContiguous = PyBufferFlags<FORMAT, true, true, false, WRITABLE, CONTIGUITY_C>

The state after requesting C contiguity.
Source§

type WithFContiguous = PyBufferFlags<FORMAT, true, true, false, WRITABLE, CONTIGUITY_F>

The state after requesting Fortran contiguity.
Source§

type WithAnyContiguous = PyBufferFlags<FORMAT, true, true, false, WRITABLE, CONTIGUITY_ANY>

The state after requesting either C or Fortran contiguity.
Source§

impl<const FORMAT: bool, const SHAPE: bool, const STRIDE: bool, const INDIRECT: bool, const WRITABLE: bool, const CONTIGUITY: u8> Sealed for PyBufferFlags<FORMAT, SHAPE, STRIDE, INDIRECT, WRITABLE, CONTIGUITY>

Auto Trait Implementations§

§

impl<const FORMAT: bool, const SHAPE: bool, const STRIDE: bool, const INDIRECT: bool, const WRITABLE: bool, const CONTIGUITY: u8> Freeze for PyBufferFlags<FORMAT, SHAPE, STRIDE, INDIRECT, WRITABLE, CONTIGUITY>

§

impl<const FORMAT: bool, const SHAPE: bool, const STRIDE: bool, const INDIRECT: bool, const WRITABLE: bool, const CONTIGUITY: u8> RefUnwindSafe for PyBufferFlags<FORMAT, SHAPE, STRIDE, INDIRECT, WRITABLE, CONTIGUITY>

§

impl<const FORMAT: bool, const SHAPE: bool, const STRIDE: bool, const INDIRECT: bool, const WRITABLE: bool, const CONTIGUITY: u8> Send for PyBufferFlags<FORMAT, SHAPE, STRIDE, INDIRECT, WRITABLE, CONTIGUITY>

§

impl<const FORMAT: bool, const SHAPE: bool, const STRIDE: bool, const INDIRECT: bool, const WRITABLE: bool, const CONTIGUITY: u8> Sync for PyBufferFlags<FORMAT, SHAPE, STRIDE, INDIRECT, WRITABLE, CONTIGUITY>

§

impl<const FORMAT: bool, const SHAPE: bool, const STRIDE: bool, const INDIRECT: bool, const WRITABLE: bool, const CONTIGUITY: u8> Unpin for PyBufferFlags<FORMAT, SHAPE, STRIDE, INDIRECT, WRITABLE, CONTIGUITY>

§

impl<const FORMAT: bool, const SHAPE: bool, const STRIDE: bool, const INDIRECT: bool, const WRITABLE: bool, const CONTIGUITY: u8> UnsafeUnpin for PyBufferFlags<FORMAT, SHAPE, STRIDE, INDIRECT, WRITABLE, CONTIGUITY>

§

impl<const FORMAT: bool, const SHAPE: bool, const STRIDE: bool, const INDIRECT: bool, const WRITABLE: bool, const CONTIGUITY: u8> UnwindSafe for PyBufferFlags<FORMAT, SHAPE, STRIDE, INDIRECT, WRITABLE, CONTIGUITY>

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