Struct PyBuffer 

pub struct PyBuffer {
    pub obj: PyObjectRef,
    pub desc: BufferDescriptor,
    /* private fields */
}

Fields

obj: PyObjectRef

desc: BufferDescriptor

Implementations

impl PyBuffer

pub fn new( obj: PyObjectRef, desc: BufferDescriptor, methods: &'static BufferMethods, ) -> Self

pub fn as_contiguous(&self) -> Option<BorrowedValue<'_, [u8]>>

pub fn as_contiguous_mut(&self) -> Option<BorrowedValueMut<'_, [u8]>>

pub fn from_byte_vector(bytes: Vec<u8>, vm: &VirtualMachine) -> Self

pub unsafe fn contiguous_unchecked(&self) -> BorrowedValue<'_, [u8]>

Safety

assume the buffer is contiguous

pub unsafe fn contiguous_mut_unchecked(&self) -> BorrowedValueMut<'_, [u8]>

Safety

assume the buffer is contiguous and writable

pub fn append_to(&self, buf: &mut Vec<u8>)

pub fn contiguous_or_collect<R, F: FnOnce(&[u8]) -> R>(&self, f: F) -> R

pub fn to_contiguous(&self, vm: &VirtualMachine) -> Self

A copy of these bytes in C order, keeping shape and format. The copy borrows nothing from the exporter, so it can be read while the exporter is borrowed for writing.

pub fn obj_as<T: PyObjectPayload>(&self) -> &Py<T>

pub fn obj_bytes(&self) -> BorrowedValue<'_, [u8]>

pub fn obj_bytes_mut(&self) -> BorrowedValueMut<'_, [u8]>

pub fn release(&self)

Give up this handle’s share of the acquisition. PyBuffer_Release

Idempotent: a handle that has already been released owns nothing, so dropping it afterwards does nothing, like a Py_buffer whose obj was cleared.

This can run arbitrary Python through __release_buffer__, so no borrow of the exporter may be held while a buffer is released or dropped.

pub fn detached(&self) -> Self

A copy that owns no share: it reads the same memory, but releasing it is inert and it never finalizes the acquisition. A Py_buffer whose obj is NULL.

impl PyBuffer

pub fn from_object( vm: &VirtualMachine, obj: &PyObject, flags: BufferFlags, ) -> PyResult<Self>

Acquire a buffer from obj. PyObject_GetBuffer

Trait Implementations

impl Clone for PyBuffer

Cloning takes another share of the same acquisition rather than asking the exporter for a new one, and the exporter’s release waits for the last share. mbuf_add_view

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PyBuffer

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

Formats the value using the given formatter.

impl Drop for PyBuffer

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.

impl From<ArgBytesLike> for PyBuffer

fn from(buffer: ArgBytesLike) -> Self

Converts to this type from the input type.

impl From<ArgMemoryBuffer> for PyBuffer

fn from(buffer: ArgMemoryBuffer) -> Self

Converts to this type from the input type.

impl Traverse for PyBuffer

fn traverse(&self, tracer_fn: &mut TraverseFn<'_>)

impl traverse() with caution! Following those guideline so traverse doesn’t cause memory error!:

fn clear(&mut self, _out: &mut Vec<PyObjectRef>)

Extract all owned child PyObjectRefs for circular reference resolution (tp_clear). Called just before object deallocation to break circular references. Default implementation does nothing.

impl<'a> TryFromBorrowedObject<'a> for PyBuffer

The request a conversion makes when the consumer has no say in it: describe the export as fully as possible, read-only.

fn try_from_borrowed_object( vm: &VirtualMachine, obj: &'a PyObject, ) -> PyResult<Self>

Attempt to convert a Python object to a value of this type.