Struct PySelection 

pub struct PySelection { /* private fields */ }

Implementations

impl PySelection

pub fn parse(_cls: Bound<'_, PyType>, input: &str) -> PyResult<Self>

Parses a selection expression from a string.

This allows you to construct a PySelection using the selection algebra surface syntax, such as "(*, 0:4, ?)".

Raises: ValueError: If the input string is not a valid selection expression.

Example: PySelection.from_string(“(*, 1:3, ?)”) # subset of a mesh

pub fn all(_cls: Bound<'_, PyType>) -> Self

Selects all elements in the mesh — use this to mean “route to all nodes”.

The ‘*’ expression is automatically expanded to match the dimensionality of the slice. For example, in a 3D slice, the selection becomes *, *, *.

pub fn any(_cls: Bound<'_, PyType>) -> Self

Selects one element nondeterministically — use this to mean “route to a single random node”.

The ‘?’ expression is automatically expanded to match the dimensionality of the slice. For example, in a 3D slice, the selection becomes ?, ?, ?.

Trait Implementations

impl From<Selection> for PySelection

fn from(inner: Selection) -> Self

Converts to this type from the input type.

impl<'py> IntoPyObject<'py> for PySelection

type Target = PySelection

The Python output type

type Output = Bound<'py, <PySelection 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 PyClass for PySelection

type Frozen = True

Whether the pyclass is frozen.

impl PyClassImpl for PySelection

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = c"\x00"

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<PySelection>

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForPySelection

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 = PyClassDummySlot

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 lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl<'a, 'holder, 'py> PyFunctionArgument<'a, 'holder, 'py, false> for &'holder PySelection

type Holder = Option<PyClassGuard<'a, PySelection>>

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

impl PyTypeInfo for PySelection

const NAME: &'static str = "Selection"

Class name.

const MODULE: Option<&'static str>

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

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl DerefToPyAny for PySelection