rustpython_vm::object

Struct Py

pub struct Py<T: PyObjectPayload>(/* private fields */);

Implementations§

impl Py<PyDict>

pub fn to_attributes( &self, vm: &VirtualMachine, ) -> IndexMap<&'static PyStrInterned, PyObjectRef, RandomState>

Take a python dictionary and convert it to attributes.

pub fn get_item_opt<K: DictKey + ?Sized>( &self, key: &K, vm: &VirtualMachine, ) -> PyResult<Option<PyObjectRef>>

pub fn get_item<K: DictKey + ?Sized>( &self, key: &K, vm: &VirtualMachine, ) -> PyResult

pub fn set_item<K: DictKey + ?Sized>( &self, key: &K, value: PyObjectRef, vm: &VirtualMachine, ) -> PyResult<()>

pub fn del_item<K: DictKey + ?Sized>( &self, key: &K, vm: &VirtualMachine, ) -> PyResult<()>

pub fn get_chain<K: DictKey + ?Sized>( &self, other: &Self, key: &K, vm: &VirtualMachine, ) -> PyResult<Option<PyObjectRef>>

impl Py<Frame>

pub fn f_back(&self, vm: &VirtualMachine) -> Option<PyRef<Frame>>

impl Py<PyModule>

pub fn __init_methods(&self, vm: &VirtualMachine) -> PyResult<()>

pub fn dict(&self) -> PyDictRef

pub fn get_attr<'a>( &self, attr_name: impl AsPyStr<'a>, vm: &VirtualMachine, ) -> PyResult

pub fn set_attr<'a>( &self, attr_name: impl AsPyStr<'a>, attr_value: impl Into<PyObjectRef>, vm: &VirtualMachine, ) -> PyResult<()>

impl Py<PyType>

pub fn fast_issubclass(&self, cls: &impl Borrow<PyObject>) -> bool

Determines if subclass is actually a subclass of cls, this doesn’t call subclasscheck, so only use this if cls is known to have not overridden the base subclasscheck magic method.

pub fn mro_map_collect<F, R>(&self, f: F) -> Vec<R>
where F: Fn(&Self) -> R,

pub fn mro_collect(&self) -> Vec<PyRef<PyType>>

pub fn iter_base_chain(&self) -> impl Iterator<Item = &Py<PyType>>

pub fn extend_methods( &'static self, method_defs: &'static [PyMethodDef], ctx: &Context, )

impl Py<Frame>

pub fn run(&self, vm: &VirtualMachine) -> PyResult<ExecutionResult>

pub fn yield_from_target(&self) -> Option<PyObjectRef>

pub fn is_internal_frame(&self) -> bool

pub fn next_external_frame(&self, vm: &VirtualMachine) -> Option<FrameRef>

impl Py<HeapMethodDef>

pub fn build_function(&self, vm: &VirtualMachine) -> PyRef<PyNativeFunction>

pub fn build_method( &self, class: &'static Py<PyType>, vm: &VirtualMachine, ) -> PyRef<PyMethodDescriptor>

impl Py<PyWeak>

pub fn upgrade(&self) -> Option<PyObjectRef>

impl<T: PyObjectPayload> Py<T>

pub fn downgrade( &self, callback: Option<PyObjectRef>, vm: &VirtualMachine, ) -> PyResult<PyWeakRef<T>>

Trait Implementations§

impl<T: PyObjectPayload> AsRef<Py<T>> for PyExact<T>

fn as_ref(&self) -> &Py<T>

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

impl<T> AsRef<Py<T>> for PyRef<T>
where T: PyObjectPayload,

fn as_ref(&self) -> &Py<T>

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

impl<T: PyObjectPayload> AsRef<Py<T>> for PyRefExact<T>

fn as_ref(&self) -> &Py<T>

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

impl<T> AsRef<PyObject> for Py<T>
where T: PyObjectPayload,

fn as_ref(&self) -> &PyObject

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

impl AsRef<str> for Py<PyStr>

fn as_ref(&self) -> &str

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

impl<T: PyObjectPayload> Borrow<Py<T>> for PyExact<T>

fn borrow(&self) -> &Py<T>

Immutably borrows from an owned value. Read more

impl<T> Borrow<Py<T>> for PyRef<T>
where T: PyObjectPayload,

fn borrow(&self) -> &Py<T>

Immutably borrows from an owned value. Read more

impl<T: PyObjectPayload> Borrow<Py<T>> for PyRefExact<T>

fn borrow(&self) -> &Py<T>

Immutably borrows from an owned value. Read more

impl<T: PyObjectPayload> Borrow<PyObject> for Py<T>

fn borrow(&self) -> &PyObject

Immutably borrows from an owned value. Read more

impl<T: PyObjectPayload> Debug for Py<T>

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

Formats the value using the given formatter. Read more

impl<T: PyObjectPayload> Deref for Py<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T> Display for Py<T>
where T: PyObjectPayload + Display,

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

Formats the value using the given formatter. Read more

impl<'a, T: PyObjectPayload> From<&'a Py<T>> for &'a PyObject

fn from(py_ref: &'a Py<T>) -> Self

Converts to this type from the input type.

impl<T> Hash for Py<T>
where T: Hash + PyObjectPayload,

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

Feeds this value into the given Hasher. Read more

1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more

impl<'a> IntoIterator for &'a Py<PyDict>

type Item = (PyObjectRef, PyObjectRef)

The type of the elements being iterated over.

type IntoIter = DictIter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more

impl<'a> IntoIterator for &'a Py<PyTuple>

type Item = &'a PyObjectRef

The type of the elements being iterated over.

type IntoIter = Iter<'a, PyObjectRef>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more

impl<T> PartialEq for Py<T>
where T: PartialEq + PyObjectPayload,

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

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

1.0.0 · Source§

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<T: PyObjectPayload> ToOwned for Py<T>

type Owned = PyRef<T>

The resulting type after obtaining ownership.

fn to_owned(&self) -> Self::Owned

Creates owned data from borrowed data, usually by cloning. Read more

1.63.0 · Source§

fn clone_into(&self, target: &mut Self::Owned)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T: PyObjectPayload> Traverse for Py<T>

fn traverse(&self, tracer_fn: &mut TraverseFn<'_>)

DO notice that call trace on Py<T> means apply tracer_fn on Py<T>’s children, not like call trace on PyRef<T> which apply tracer_fn on PyRef<T> itself

impl<'a, T: PyPayload> TryFromBorrowedObject<'a> for &'a Py<T>

fn try_from_borrowed_object( vm: &VirtualMachine, obj: &'a PyObject, ) -> PyResult<Self>

Attempt to convert a Python object to a value of this type.

impl<T> Eq for Py<T>
where T: Eq + PyObjectPayload,

Auto Trait Implementations§

impl<T> !Freeze for Py<T>

impl<T> !RefUnwindSafe for Py<T>

impl<T> !Send for Py<T>

impl<T> !Sync for Py<T>

impl<T> Unpin for Py<T>
where T: Unpin,

impl<T> !UnwindSafe for Py<T>

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> AsObject for T
where T: Borrow<PyObject>,

fn as_object(&self) -> &PyObject

fn get_id(&self) -> usize

fn is<T>(&self, other: &T) -> bool
where T: AsObject,

fn class(&self) -> &Py<PyType>

fn get_class_attr( &self, attr_name: &'static PyStrInterned, ) -> Option<PyObjectRef>

fn fast_isinstance(&self, cls: &Py<PyType>) -> bool

Determines if obj actually an instance of cls, this doesn’t call instancecheck, so only use this if cls is known to have not overridden the base instancecheck magic method.

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T, U> ExactFrom<T> for U
where U: TryFrom<T>,

fn exact_from(value: T) -> U

impl<T, U> ExactInto<U> for T
where U: ExactFrom<T>,

fn exact_into(self) -> U

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

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 more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

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

impl<T, U> OverflowingInto<U> for T
where U: OverflowingFrom<T>,

fn overflowing_into(self) -> (U, bool)

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)

The target type on which the method may be called.

impl<T, U> RoundingInto<U> for T
where U: RoundingFrom<T>,

fn rounding_into(self, rm: RoundingMode) -> (U, Ordering)

impl<T, U> SaturatingInto<U> for T
where U: SaturatingFrom<T>,

fn saturating_into(self) -> U

impl<T> ToDebugString for T
where T: Debug,

fn to_debug_string(&self) -> String

Returns the String produced by Ts Debug implementation.

§Examples

use malachite_base::strings::ToDebugString;

assert_eq!([1, 2, 3].to_debug_string(), "[1, 2, 3]");
assert_eq!(
    [vec![2, 3], vec![], vec![4]].to_debug_string(),
    "[[2, 3], [], [4]]"
);
assert_eq!(Some(5).to_debug_string(), "Some(5)");

impl<T> ToString for T
where T: Display + ?Sized,

fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T, U> WrappingInto<U> for T
where U: WrappingFrom<T>,

fn wrapping_into(self) -> U

impl<T> PyThreadingConstraint for T