Struct Server 

pub struct Server { /* private fields */ }

A tsnet.Server-shaped embedded Tailscale node, exposing the two surfaces the plain [connect]-built Device does not: the dual-credential loopback and the LocalClient.

Construct it with the Go-tsnet.Server fields (all optional keyword arguments); the wrapped node is built lazily on the first loopback / local_client call. Fork config supersets beyond Go tsnet parity (exit nodes, forwarding) remain on [connect]/Device; this is the Go-parity Server surface. Cleanup happens on garbage collection (the loopback listeners and node shut down when the last reference drops).

Implementations

impl Server

pub fn new( hostname: Option<String>, auth_key: Option<String>, control_url: Option<String>, ephemeral: bool, dir: Option<String>, tags: Option<Vec<String>>, ) -> Self

Create a new server (Go &tsnet.Server{Hostname, AuthKey, ControlURL, Ephemeral, Dir}).

All arguments are optional keyword arguments: hostname, auth_key, control_url, ephemeral (default False, matching Go), dir (a state directory persisting this node’s identity keys across runs; None gives a fresh ephemeral in-memory identity), and tags (ACL tags to advertise). No network I/O happens here — the node is built on first use.

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

Start (once) the loopback surface and return (socks_addr, proxy_cred, localapi_addr, localapi_cred) (Go Loopback() (addr, proxyCred, localAPICred, err)).

socks_addr is the SOCKS5 proxy’s bound 127.0.0.1:port (password proxy_cred, username tsnet); localapi_addr is the in-process LocalAPI HTTP server’s bound 127.0.0.1:port (HTTP Basic-auth password localapi_cred). Both listeners live for the server’s lifetime, so repeated calls return the same addresses and credentials. Raises in TUN transport mode.

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

A LocalClient for this node’s in-process LocalAPI HTTP server (Go tsnet.Server.LocalClient()), starting the loopback surface if needed.

Trait Implementations

impl DerefToPyAny for Server

impl ExtractPyClassWithClone for Server

impl<'py> IntoPyObject<'py> for Server

type Target = Server

The Python output type

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

const NAME: &str = "Server"

Name of the class.

type Frozen = True

Whether the pyclass is frozen.

impl PyClassImpl for Server

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 `tsnet.Server`-shaped embedded Tailscale node, exposing the two surfaces the plain /// [`connect`]-built [`Device`] does not: the **dual-credential loopback** and the **LocalClient**. /// /// Construct it with the Go-`tsnet.Server` fields (all optional keyword arguments); the wrapped node /// is built lazily on the first [`loopback`][Self::loopback] / [`local_client`][Self::local_client] /// call. Fork config supersets beyond Go `tsnet` parity (exit nodes, forwarding) remain on /// [`connect`]/[`Device`]; this is the Go-parity `Server` surface. Cleanup happens on garbage /// collection (the loopback listeners and node shut down when the last reference drops).

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

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

const TEXT_SIGNATURE: &'static str = "(*, hostname=None, auth_key=None, control_url=None, ephemeral=False, dir=None, tags=None)"

impl PyMethods<Server> for PyClassImplCollector<Server>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for Server

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.