Struct pyo3::types::PyBytes

#[repr(transparent)]
pub struct PyBytes(_);

Represents a Python bytes.

This type is immutable

Methods

impl PyBytes

pub fn new<'p>(py: Python<'p>, s: &[u8]) -> &'p PyBytes

Creates a new Python byte string object. The byte string is initialized by copying the data from the &[u8].

Panics if out of memory.

pub unsafe fn from_ptr(py: Python, ptr: *const u8, len: usize) -> &PyBytes

Creates a new Python byte string object from raw pointer.

Panics if out of memory.

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

Get the Python string as a byte slice.

Trait Implementations

impl AsPyPointer for PyBytes

fn as_ptr(&self) -> *mut PyObject

Gets the underlying FFI pointer, returns a borrowed pointer.

impl ToPyObject for PyBytes

fn to_object(&self, py: Python) -> PyObject

Converts self into a Python object.

impl PyNativeType for PyBytes

fn py(&self) -> Python

impl PyTypeInfo for PyBytes

type Type = ()

Type of objects to store in PyObject struct

type BaseType = PyAny

Base class

const NAME: &'static str

Class name

const MODULE: Option<&'static str>

Module name, if any

const SIZE: usize

Size of the rust PyObject structure (PyObject + rust structure)

const OFFSET: isize

Type instance offset inside PyObject structure

unsafe fn type_object() -> &'static mut PyTypeObject

PyTypeObject instance for this type, which might still need to be initialized

fn is_instance(ptr: &PyAny) -> bool

Check if *mut ffi::PyObject is instance of this type

const DESCRIPTION: &'static str

Class doc string

const FLAGS: usize

Type flags (ie PY_TYPE_FLAG_GC, PY_TYPE_FLAG_WEAKREF)

fn is_exact_instance(object: &PyAny) -> bool

Check if *mut ffi::PyObject is exact instance of this type

impl PyObjectAlloc for PyBytes

unsafe fn alloc(_py: Python) -> *mut PyObject

unsafe fn dealloc(py: Python, obj: *mut PyObject)

Calls the rust destructor for the object and frees the memory (usually by calling ptr->ob_type->tp_free). This function is used as tp_dealloc implementation.

unsafe fn drop(py: Python, obj: *mut PyObject)

Calls the rust destructor for the object.

impl PyTypeObject for PyBytes

fn init_type() -> NonNull<PyTypeObject>

This function must make sure that the corresponding type object gets initialized exactly once and return it.

fn type_object() -> Py<PyType>

Returns the safe abstraction over the type object from PyTypeObject::init_type

impl AsRef<PyAny> for PyBytes

fn as_ref(&self) -> &PyAny

Performs the conversion.

impl<'a> From<&'a PyBytes> for &'a PyAny

fn from(ob: &'a PyBytes) -> Self

Performs the conversion.

impl PartialEq<PyBytes> for PyBytes

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Display for PyBytes

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

Formats the value using the given formatter.

impl Debug for PyBytes

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

Formats the value using the given formatter.

impl<I: SliceIndex<[u8]>> Index<I> for PyBytes

This is the same way Vec is indexed

type Output = I::Output

The returned type after indexing.

fn index(&self, index: I) -> &Self::Output

Performs the indexing (container[index]) operation.