Struct pyo3::types::PyByteArray

#[repr(transparent)]
pub struct PyByteArray(_, _);

Represents a Python bytearray.

Methods

impl PyByteArray

pub fn new<'p>(py: Python<'p>, src: &[u8]) -> &'p PyByteArray

Creates a new Python bytearray object. The byte string is initialized by copying the data from the &[u8].

pub fn from<'p, I>(py: Python<'p>, src: &'p I) -> PyResult<&'p PyByteArray> where
    I: AsPyPointer, 

Creates a new Python bytearray object from other PyObject, that implements the buffer protocol.

pub fn len(&self) -> usize

Gets the length of the bytearray.

pub fn is_empty(&self) -> bool

Check if bytearray is empty.

pub fn to_vec(&self) -> Vec<u8>

Copies the contents of the bytearray to a rust vector

Example

let bytearray = PyByteArray::new(py, b"Hello World.");
let mut copied_message = bytearray.to_vec();
assert_eq!(b"Hello World.", copied_message.as_slice());

copied_message[11] = b'!';
assert_eq!(b"Hello World!", copied_message.as_slice());

let locals = [("bytearray", bytearray)].into_py_dict(py);
py.run("assert bytearray == b'Hello World.'", None, Some(locals)).unwrap();

pub fn resize(&self, len: usize) -> PyResult<()>

Resize bytearray object to len.

Trait Implementations

impl AsPyPointer for PyByteArray

fn as_ptr(&self) -> *mut PyObject

Gets the underlying FFI pointer, returns a borrowed pointer.

impl AsRef<PyAny> for PyByteArray

fn as_ref(&self) -> &PyAny

Performs the conversion.

impl Debug for PyByteArray

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

Formats the value using the given formatter.

impl Display for PyByteArray

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

Formats the value using the given formatter.

impl<'a> From<&'a PyByteArray> for &'a PyAny

fn from(ob: &'a PyByteArray) -> Self

Performs the conversion.

impl PartialEq<PyByteArray> for PyByteArray

fn eq(&self, o: &PyByteArray) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PyNativeType for PyByteArray

fn py(&self) -> Python

impl PyObjectAlloc for PyByteArray

unsafe fn alloc(_py: Python) -> *mut PyObject

unsafe fn dealloc(py: Python, obj: *mut PyObject)

Calls the rust destructor for the object and frees the memory (usually by calling ptr->ob_type->tp_free). This function is used as tp_dealloc implementation.

unsafe fn drop(py: Python, obj: *mut PyObject)

Calls the rust destructor for the object.

impl PyTypeInfo for PyByteArray

type Type = ()

Type of objects to store in PyObject struct

type BaseType = PyAny

Base class

const NAME: &'static str

Class name

const MODULE: Option<&'static str>

Module name, if any

const SIZE: usize

Size of the rust PyObject structure (PyObject + rust structure)

const OFFSET: isize

Type instance offset inside PyObject structure

unsafe fn type_object() -> &'static mut PyTypeObject

PyTypeObject instance for this type, which might still need to be initialized

fn is_instance(ptr: &PyAny) -> bool

Check if *mut ffi::PyObject is instance of this type

const DESCRIPTION: &'static str

Class doc string

const FLAGS: usize

Type flags (ie PY_TYPE_FLAG_GC, PY_TYPE_FLAG_WEAKREF)

fn is_exact_instance(object: &PyAny) -> bool

Check if *mut ffi::PyObject is exact instance of this type

impl PyTypeObject for PyByteArray

fn init_type() -> NonNull<PyTypeObject>

This function must make sure that the corresponding type object gets initialized exactly once and return it.

fn type_object() -> Py<PyType>

Returns the safe abstraction over the type object from PyTypeObject::init_type

impl ToPyObject for PyByteArray

fn to_object(&self, py: Python) -> PyObject

Converts self into a Python object.