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 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)

pub fn retain(&self)

Trait Implementations

impl Clone for PyBuffer

fn clone(&self) -> PyBuffer

Returns a copy 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.

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!:

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

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

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