Struct PyByteArray

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

Available on crate features dep_pyo3 and std only.

Represents a Python bytearray.

Values of this type are accessed via PyO3’s smart pointers, e.g. as Py<PyByteArray> or Bound<'py, PyByteArray>.

For APIs available on bytearray objects, see the PyByteArrayMethods trait which is implemented for Bound<'py, PyByteArray>.

Implementations

impl PyByteArray

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

Creates a new Python bytearray object.

The byte string is initialized by copying the data from the &[u8].

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

👎Deprecated since 0.23.0: renamed to PyByteArray::new

Deprecated name for PyByteArray::new.

pub fn new_with<F>( py: Python<'_>, len: usize, init: F, ) -> Result<Bound<'_, PyByteArray>, PyErr>

where F: FnOnce(&mut [u8]) -> Result<(), PyErr>,

Creates a new Python bytearray object with an init closure to write its contents. Before calling init the bytearray is zero-initialised.

• If Python raises a MemoryError on the allocation, new_with will return it inside Err.
• If init returns Err(e), new_with will return Err(e).
• If init returns Ok(()), new_with will return Ok(&PyByteArray).

Examples

use pyo3::{prelude::*, types::PyByteArray};

Python::with_gil(|py| -> PyResult<()> {
    let py_bytearray = PyByteArray::new_with(py, 10, |bytes: &mut [u8]| {
        bytes.copy_from_slice(b"Hello Rust");
        Ok(())
    })?;
    let bytearray: &[u8] = unsafe { py_bytearray.as_bytes() };
    assert_eq!(bytearray, b"Hello Rust");
    Ok(())
})

pub fn new_bound_with<F>( py: Python<'_>, len: usize, init: F, ) -> Result<Bound<'_, PyByteArray>, PyErr>

where F: FnOnce(&mut [u8]) -> Result<(), PyErr>,

👎Deprecated since 0.23.0: renamed to PyByteArray::new_with

Deprecated name for PyByteArray::new_with.

pub fn from<'py>( src: &Bound<'py, PyAny>, ) -> Result<Bound<'py, PyByteArray>, PyErr>

Creates a new Python bytearray object from another Python object that implements the buffer protocol.

pub fn from_bound<'py>( src: &Bound<'py, PyAny>, ) -> Result<Bound<'py, PyByteArray>, PyErr>

👎Deprecated since 0.23.0: renamed to PyByteArray::from

Deprecated name for PyByteArray::from.

Trait Implementations

impl AsRef<PyAny> for PyByteArray

fn as_ref(&self) -> &PyAny

Converts this type into a shared reference of the (usually inferred) input type.

impl Deref for PyByteArray

type Target = PyAny

The resulting type after dereferencing.

fn deref(&self) -> &PyAny

Dereferences the value.

impl PyTypeInfo for PyByteArray

const NAME: &'static str = "PyByteArray"

Class name.

const MODULE: Option<&'static str>

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn is_type_of_bound(obj: &Bound<'_, PyAny>) -> bool

👎Deprecated since 0.23.0: renamed to PyTypeInfo::is_type_of

Deprecated name for PyTypeInfo::is_type_of.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn type_object_bound(py: Python<'_>) -> Bound<'_, PyType>

👎Deprecated since 0.23.0: renamed to PyTypeInfo::type_object

Deprecated name for PyTypeInfo::type_object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

fn is_exact_type_of_bound(object: &Bound<'_, PyAny>) -> bool

👎Deprecated since 0.23.0: renamed to PyTypeInfo::is_exact_type_of

Deprecated name for PyTypeInfo::is_exact_type_of.

impl DerefToPyAny for PyByteArray