Struct pyo3::types::bytearray::PyByteArray
source · #[repr(transparent)]pub struct PyByteArray(PyAny);
Expand description
Represents a Python bytearray
.
Tuple Fields§
§0: PyAny
Implementations§
source§impl PyByteArray
impl PyByteArray
#[doc(hidden)] pub const _PYO3_DEF: AddTypeToModule<Self> = _
source§impl PyByteArray
impl PyByteArray
sourcepub fn new_bound<'py>(py: Python<'py>, src: &[u8]) -> Bound<'py, PyByteArray>
pub fn new_bound<'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_bound_with<F>(
py: Python<'_>,
len: usize,
init: F
) -> PyResult<Bound<'_, PyByteArray>>
pub fn new_bound_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_bound_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(())
})
sourcepub fn from_bound<'py>(
src: &Bound<'py, PyAny>
) -> PyResult<Bound<'py, PyByteArray>>
pub fn from_bound<'py>( src: &Bound<'py, PyAny> ) -> PyResult<Bound<'py, PyByteArray>>
Creates a new Python bytearray
object from another Python object that
implements the buffer protocol.
Methods from Deref<Target = PyAny>§
#[doc(hidden)] pub const _PYO3_DEF: AddTypeToModule<Self> = _
Trait Implementations§
source§impl AsPyPointer for PyByteArray
impl AsPyPointer for PyByteArray
source§impl AsRef<PyAny> for PyByteArray
impl AsRef<PyAny> for PyByteArray
source§impl Deref for PyByteArray
impl Deref for PyByteArray
source§impl PyTypeInfo for PyByteArray
impl PyTypeInfo for PyByteArray
source§const NAME: &'static str = "PyByteArray"
const NAME: &'static str = "PyByteArray"
Available on non-crate feature
gil-refs
only.Class name.
source§const MODULE: Option<&'static str> = _
const MODULE: Option<&'static str> = _
Available on non-crate feature
gil-refs
only.Module name, if any.
source§fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
Available on non-crate feature
gil-refs
only.Returns the PyTypeObject instance for this type.
source§fn is_type_of_bound(obj: &Bound<'_, PyAny>) -> bool
fn is_type_of_bound(obj: &Bound<'_, PyAny>) -> bool
Available on non-crate feature
gil-refs
only.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 more