Struct LocalClient 

pub struct LocalClient { /* private fields */ }

A minimal client for this node’s in-process LocalAPI HTTP server (Go tsnet.Server.LocalClient() → *local.Client), obtained from Server::local_client.

It authenticates every request with the loopback’s LocalAPI credential and speaks plain HTTP to 127.0.0.1. LocalAPI responses are JSON/text, decoded here as UTF-8 str.

Implementations

impl LocalClient

pub fn status<'p>(&self, py: Python<'p>) -> PyResult<Bound<'p, PyAny>>

GET /localapi/v0/status — the node + peer status as a JSON str (Go LocalClient().Status, over the loopback). Raises if the server answers non-200.

pub fn get<'p>( &self, py: Python<'p>, path: String, ) -> PyResult<Bound<'p, PyAny>>

Perform an authenticated GET against an arbitrary LocalAPI path (e.g. "/localapi/v0/status"), returning (http_status_code, body) where body is the response decoded as a UTF-8 str.

pub fn address(&self) -> String

The 127.0.0.1:port address of the LocalAPI HTTP server this client talks to.

pub fn credential(&self) -> String

The LocalAPI credential (HTTP Basic-auth password) this client sends.

Trait Implementations

impl DerefToPyAny for LocalClient

impl ExtractPyClassWithClone for LocalClient

impl<'py> IntoPyObject<'py> for LocalClient

type Target = LocalClient

The Python output type

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

const NAME: &str = "LocalClient"

Name of the class.

type Frozen = True

Whether the pyclass is frozen.

impl PyClassImpl for LocalClient

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 = /// A minimal client for this node's in-process LocalAPI HTTP server (Go /// `tsnet.Server.LocalClient()` → `*local.Client`), obtained from [`Server::local_client`]. /// /// It authenticates every request with the loopback's LocalAPI credential and speaks plain HTTP to /// `127.0.0.1`. LocalAPI responses are JSON/text, decoded here as UTF-8 `str`.

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

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>::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<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<LocalClient> for PyClassImplCollector<LocalClient>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for LocalClient

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.