#[repr(transparent)]pub struct PyByteArray(PyAny);
Expand description
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>
.
Tuple Fields§
§0: PyAny
Implementations§
Source§impl PyByteArray
impl PyByteArray
#[doc(hidden)] pub const _PYO3_DEF: AddTypeToModule<Self>
#[doc(hidden)] pub const _PYO3_INTROSPECTION_ID: &'static str = ":: std :: option :: Option :: Some(\"builtins\")PyByteArray"
Source§impl PyByteArray
impl PyByteArray
Sourcepub fn new<'py>(py: Python<'py>, src: &[u8]) -> Bound<'py, 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]
.
Sourcepub fn new_with<F>(
py: Python<'_>,
len: usize,
init: F,
) -> PyResult<Bound<'_, PyByteArray>>
pub fn new_with<F>( py: Python<'_>, len: usize, init: F, ) -> PyResult<Bound<'_, PyByteArray>>
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 insideErr
. - If
init
returnsErr(e)
,new_with
will returnErr(e)
. - If
init
returnsOk(())
,new_with
will returnOk(&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(())
})
Trait Implementations§
Source§impl PyTypeInfo for PyByteArray
impl PyTypeInfo for PyByteArray
Source§fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
Returns the PyTypeObject instance for this type.
Source§fn is_type_of(obj: &Bound<'_, PyAny>) -> bool
fn is_type_of(obj: &Bound<'_, PyAny>) -> bool
Checks if
object
is an instance of this type or a subclass of this type.impl DerefToPyAny for PyByteArray
Auto Trait Implementations§
impl !Freeze for PyByteArray
impl !RefUnwindSafe for PyByteArray
impl !Send for PyByteArray
impl !Sync for PyByteArray
impl Unpin for PyByteArray
impl UnwindSafe for PyByteArray
Blanket Implementations§
Source§impl<T> AssertNotZeroSized for T
impl<T> AssertNotZeroSized for T
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> PyTypeCheck for Twhere
T: PyTypeInfo,
impl<T> PyTypeCheck for Twhere
T: PyTypeInfo,
Source§impl<T> SizedTypeProperties for T
impl<T> SizedTypeProperties for T
Source§#[doc(hidden)] const IS_ZST: bool = _
#[doc(hidden)] const IS_ZST: bool = _
🔬This is a nightly-only experimental API. (
sized_type_properties
)Source§#[doc(hidden)] const LAYOUT: Layout = _
#[doc(hidden)] const LAYOUT: Layout = _
🔬This is a nightly-only experimental API. (
sized_type_properties
)Source§#[doc(hidden)] const MAX_SLICE_LEN: usize = _
#[doc(hidden)] const MAX_SLICE_LEN: usize = _
🔬This is a nightly-only experimental API. (
sized_type_properties
)The largest safe length for a
[Self]
. Read more