Struct pyo3::types::PySlice

#[repr(transparent)]
pub struct PySlice(_, _);

Represents a Python slice.

Only c_long indices supported at the moment by PySlice object.

Methods

impl PySlice

pub fn new(py: Python, start: isize, stop: isize, step: isize) -> &PySlice

Construct a new slice with the given elements.

pub fn indices(&self, length: c_long) -> PyResult<PySliceIndices>

Retrieve the start, stop, and step indices from the slice object slice assuming a sequence of length length, and store the length of the slice in slicelength.

Trait Implementations

impl AsPyPointer for PySlice

fn as_ptr(&self) -> *mut PyObject

Gets the underlying FFI pointer, returns a borrowed pointer.

impl AsRef<PyAny> for PySlice

fn as_ref(&self) -> &PyAny

Performs the conversion.

impl Debug for PySlice

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

Formats the value using the given formatter.

impl Display for PySlice

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

Formats the value using the given formatter.

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

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

Performs the conversion.

impl PartialEq<PySlice> for PySlice

fn eq(&self, o: &PySlice) -> 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 PyNativeType for PySlice

fn py(&self) -> Python

impl PyObjectAlloc for PySlice

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 PyTypeInfo for PySlice

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 PyTypeObject for PySlice

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 ToPyObject for PySlice

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

Converts self into a Python object.