Struct PyBytes

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

A wrapper around a bytes::Bytes.

This implements both import and export via the Python buffer protocol.

Buffer protocol import

This can be very useful as a general way to support ingest of a Python buffer protocol object.

The underlying Bytes manages the external memory, automatically calling the Python buffer’s release callback when the internal reference count reaches 0.

Note that converting this Bytes into a BytesMut will always create a deep copy of the buffer into newly allocated memory, since this Bytes is constructed from an owner.

Buffer protocol export

PyBytes implements the Python buffer protocol to enable Python to access the underlying Bytes data view without copies. In Python, this PyBytes object can be passed to Python bytes or memoryview constructors, numpy.frombuffer, or any other function that supports buffer protocol input.

Implementations

impl PyBytes

pub fn new(buffer: Bytes) -> Self

Construct a new PyBytes

pub fn into_inner(self) -> Bytes

Consume and return the Bytes

pub fn as_slice(&self) -> &[u8]

Access the underlying buffer as a byte slice

Trait Implementations

impl AsRef<[u8]> for PyBytes

fn as_ref(&self) -> &[u8]

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

impl AsRef<Bytes> for PyBytes

fn as_ref(&self) -> &Bytes

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

impl Debug for PyBytes

This is mostly the same as the upstream bytes::Bytes Debug impl, however we don’t use it because that impl doesn’t look how the python bytes repr looks; this isn’t exactly the same either, as the python repr will switch between ' and " based on the presence of the other in the string, but it’s close enough AND we don’t have to do a full scan of the bytes to check for that.

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

Formats the value using the given formatter.

impl From<Bytes> for PyBytes

fn from(value: Bytes) -> Self

Converts to this type from the input type.

impl From<BytesMut> for PyBytes

fn from(value: BytesMut) -> Self

Converts to this type from the input type.

impl From<PyBytes> for Bytes

fn from(value: PyBytes) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for PyBytes

fn from(value: Vec<u8>) -> Self

Converts to this type from the input type.

impl<'py> FromPyObject<'py> for PyBytes

fn extract_bound(ob: &Bound<'py, PyAny>) -> PyResult<Self>

Extracts Self from the bound smart pointer obj.

impl Hash for PyBytes

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoPy<Py<PyAny>> for PyBytes

fn into_py(self, py: Python<'_>) -> PyObject

👎Deprecated since 0.23.0: IntoPy is going to be replaced by IntoPyObject. See the migration guide (https://pyo3.rs/v0.23.0/migration) for more information.

Performs the conversion.

impl<'py> IntoPyObject<'py> for PyBytes

type Target = PyBytes

The Python output type

type Output = Bound<'py, <PyBytes as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl Ord for PyBytes

fn cmp(&self, other: &PyBytes) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for PyBytes

fn eq(&self, other: &PyBytes) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for PyBytes

fn partial_cmp(&self, other: &PyBytes) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PyClass for PyBytes

type Frozen = True

Whether the pyclass is frozen.

impl PyClassBaseType for PyBytes

type LayoutAsBase = PyClassObject<PyBytes>

type BaseNativeType = <PyBytes as PyClassImpl>::BaseNativeType

type Initializer = PyClassInitializer<PyBytes>

type PyClassMutability = <PyBytes as PyClassImpl>::PyClassMutability

impl PyClassImpl for PyBytes

const IS_BASETYPE: bool = true

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = true

#[pyclass(sequence)]

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<PyBytes>

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::ImmutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassWeakRefSlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn doc(py: Python<'_>) -> PyResult<&'static CStr>

Rendered class doc

fn weaklist_offset() -> Option<Py_ssize_t>

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

impl PyClassNewTextSignature<PyBytes> for PyClassImplCollector<PyBytes>

fn new_text_signature(self) -> Option<&'static str>

impl PyClass__add__SlotFragment<PyBytes> for PyClassImplCollector<PyBytes>

unsafe fn __add__( self, py: Python<'_>, _raw_slf: *mut PyObject, arg0: *mut PyObject, ) -> PyResult<*mut PyObject>

Safety: _slf and _other must be valid non-null Python objects

impl PyClass__eq__SlotFragment<PyBytes> for PyClassImplCollector<PyBytes>

unsafe fn __eq__( self, py: Python<'_>, _raw_slf: *mut PyObject, arg0: *mut PyObject, ) -> PyResult<*mut PyObject>

Safety: _slf and _other must be valid non-null Python objects

impl PyClass__mul__SlotFragment<PyBytes> for PyClassImplCollector<PyBytes>

unsafe fn __mul__( self, py: Python<'_>, _raw_slf: *mut PyObject, arg0: *mut PyObject, ) -> PyResult<*mut PyObject>

Safety: _slf and _other must be valid non-null Python objects

impl<'a, 'py> PyFunctionArgument<'a, 'py, false> for &'a PyBytes

type Holder = Option<PyRef<'py, PyBytes>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'a mut Self::Holder, ) -> PyResult<Self>

impl PyMethods<PyBytes> for PyClassImplCollector<PyBytes>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for PyBytes

const NAME: &'static str = "Bytes"

Class name.

const MODULE: Option<&'static str> = ::core::option::Option::None

Module name, if any.

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

Returns the PyTypeObject instance for this type.

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_type_of_bound(object: &Bound<'_, PyAny>) -> bool

👎Deprecated since 0.23.0: renamed to PyTypeInfo::is_type_of

Deprecated name for PyTypeInfo::is_type_of.

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 PyBytes

impl Eq for PyBytes

impl StructuralPartialEq for PyBytes