#[repr(transparent)]pub struct PyBytes(PyAny);
Expand description
Represents a Python bytes
object.
This type is immutable.
Tuple Fields§
§0: PyAny
Implementations§
source§impl PyBytes
impl PyBytes
sourcepub fn new_bound<'p>(py: Python<'p>, s: &[u8]) -> Bound<'p, PyBytes>
pub fn new_bound<'p>(py: Python<'p>, s: &[u8]) -> Bound<'p, PyBytes>
Creates a new Python bytestring object.
The bytestring is initialized by copying the data from the &[u8]
.
Panics if out of memory.
sourcepub fn new_bound_with<F>(
py: Python<'_>,
len: usize,
init: F
) -> PyResult<Bound<'_, PyBytes>>
pub fn new_bound_with<F>( py: Python<'_>, len: usize, init: F ) -> PyResult<Bound<'_, PyBytes>>
Creates a new Python bytes
object with an init
closure to write its contents.
Before calling init
the bytes’ contents are 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(&PyBytes)
.
§Examples
use pyo3::{prelude::*, types::PyBytes};
Python::with_gil(|py| -> PyResult<()> {
let py_bytes = PyBytes::new_bound_with(py, 10, |bytes: &mut [u8]| {
bytes.copy_from_slice(b"Hello Rust");
Ok(())
})?;
let bytes: &[u8] = py_bytes.extract()?;
assert_eq!(bytes, b"Hello Rust");
Ok(())
})
sourcepub unsafe fn bound_from_ptr(
py: Python<'_>,
ptr: *const u8,
len: usize
) -> Bound<'_, PyBytes>
pub unsafe fn bound_from_ptr( py: Python<'_>, ptr: *const u8, len: usize ) -> Bound<'_, PyBytes>
Creates a new Python byte string object from a raw pointer and length.
Panics if out of memory.
§Safety
This function dereferences the raw pointer ptr
as the
leading pointer of a slice of length len
. As with
std::slice::from_raw_parts
, this is
unsafe.
Methods from Deref<Target = PyAny>§
#[doc(hidden)] pub const _PYO3_DEF: AddTypeToModule<Self> = _
Trait Implementations§
source§impl AsPyPointer for PyBytes
impl AsPyPointer for PyBytes
source§impl PyTypeInfo for PyBytes
impl PyTypeInfo for PyBytes
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 PyBytes
Auto Trait Implementations§
impl !Freeze for PyBytes
impl !RefUnwindSafe for PyBytes
impl !Send for PyBytes
impl !Sync for PyBytes
impl Unpin for PyBytes
impl UnwindSafe for PyBytes
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