Struct LoopbackHandle 

pub struct LoopbackHandle { /* private fields */ }

Handle that keeps a loopback SOCKS5 proxy alive (returned by Device::loopback).

Dropping this handle — or calling stop / letting Python garbage-collect it — stops the accept loop and frees the bound 127.0.0.1 port. Hold it for exactly as long as you want the proxy.

Implementations

impl LoopbackHandle

pub fn stop(&self)

Stop the loopback SOCKS5 proxy now. Idempotent — a second call is a no-op.

pub fn __del__(&self)

Stop the proxy when the Python object is garbage-collected. Equivalent to stop.

Trait Implementations

impl DerefToPyAny for LoopbackHandle

impl ExtractPyClassWithClone for LoopbackHandle

impl<'py> IntoPyObject<'py> for LoopbackHandle

type Target = LoopbackHandle

The Python output type

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

const NAME: &str = "LoopbackHandle"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for LoopbackHandle

const MODULE: Option<&str>

Module which the class will be associated with.

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 = /// Handle that keeps a loopback SOCKS5 proxy alive (returned by [`Device::loopback`]). /// /// Dropping this handle — or calling [`stop`][Self::stop] / letting Python garbage-collect it — /// stops the accept loop and frees the bound `127.0.0.1` port. Hold it for exactly as long as you /// want the proxy.

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 Layout = <<LoopbackHandle as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<LoopbackHandle>

Description of how this class is laid out in memory

type BaseType = PyAny

Base class

type ThreadChecker = NoopThreadChecker

This handles following two situations:

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

Used to provide the dictoffset slot (equivalent to tp_dictoffset)

fn weaklist_offset() -> Option<PyObjectOffset>

Used to provide the weaklistoffset slot (equivalent to tp_weaklistoffset

impl PyMethods<LoopbackHandle> for PyClassImplCollector<LoopbackHandle>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for LoopbackHandle

const NAME: &str = <Self as ::pyo3::PyClass>::NAME

👎Deprecated since 0.28.0:

prefer using ::type_object(py).name() to get the correct runtime value

Class name.

const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE

👎Deprecated since 0.28.0:

prefer using ::type_object(py).module() to get the correct runtime value

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.