Struct ArgBytesLike 

pub struct ArgBytesLike(/* private fields */);

any bytes-like object. Like the y* format code for PyArg_Parse in CPython.

Implementations

impl ArgBytesLike

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

pub fn with_ref<F, R>(&self, f: F) -> R

where F: FnOnce(&[u8]) -> R,

pub fn borrow_buf_unlocked( &self, vm: &VirtualMachine, ) -> PyResult<UnlockedBuf<'_>>

The bytes to hand to an operation that may wait, and whatever keeps them readable while it does.

borrow_buf may answer with a lock that every other thread writing to the same object waits on, and a thread waiting on a lock never reaches a safepoint, so keeping one across a wait for a peer, a pipe or a signal stops the world from being stopped at all. Bytes reached that way are copied out first. Bytes that lock nothing – an immutable object’s – are borrowed where they lie, which is all CPython holds in either case.

pub const fn len(&self) -> usize

pub const fn itemsize(&self) -> usize

The width of one item. Callers that read the buffer as bytes rather than as whatever it holds have to ask, since a contiguous buffer of wider items is contiguous all the same.

pub const fn is_empty(&self) -> bool

pub fn as_object(&self) -> &PyObject

pub fn source_object(&self) -> &PyObject

The object whose storage is borrowed while this buffer is read: a view borrows the object it looks at, not itself.

Trait Implementations

impl Debug for ArgBytesLike

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

Formats the value using the given formatter.

impl From<ArgBytesLike> for PyBuffer

fn from(buffer: ArgBytesLike) -> Self

Converts to this type from the input type.

impl From<ArgBytesLike> for PyObjectRef

fn from(buffer: ArgBytesLike) -> Self

Converts to this type from the input type.

impl Traverse for ArgBytesLike

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 ArgBytesLike

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

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