Struct PicklingState 

pub struct PicklingState { /* private fields */ }

Python-visible wrapper for the result of a pickling operation.

Contains the pickled bytes and any tensor engine references or pending pickles that were collected during serialization.

Implementations

impl PicklingState

pub fn take_inner(&mut self) -> PyResult<PicklingStateInner>

impl PicklingState

pub async fn resolve(self) -> PyResult<PicklingState>

Resolve all pending pickles and return a new PicklingState without pending pickles.

This consumes the PicklingState. It:

1. If there are no pending pickles, returns self immediately
2. Otherwise, awaits all pending pickles until they’re finished
3. Calls unpickle to reconstruct the object
4. Calls pickle again to get a new PicklingState without pending pickles

Trait Implementations

impl<'py> IntoPyObject<'py> for PicklingState

type Target = PicklingState

The Python output type

type Output = Bound<'py, <PicklingState 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 PicklingState

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for PicklingState

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 = /// Python-visible wrapper for the result of a pickling operation. /// /// Contains the pickled bytes and any tensor engine references or pending /// pickles that were collected during serialization.

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<PicklingState>

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForPicklingState

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

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 PyClassNewTextSignature for PicklingState

const TEXT_SIGNATURE: &'static str = "(buffer, tensor_engine_references=None)"

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

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

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

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

type Holder = Option<PyClassGuardMut<'a, PicklingState>>

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

impl PyTypeInfo for PicklingState

const NAME: &'static str = "PicklingState"

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 PicklingState