Skip to main content

Client

Struct Client 

Source
pub struct Client { /* private fields */ }
Expand description

Client for the Tailscale Local API.

Connections are pooled and reused via hyper’s connection management. TCP port and auth token are discovered per-request (matching Go’s behavior), so the client adapts to daemon restarts and late starts.

Implementations§

Source§

impl Client

Source

pub fn new() -> Self

Create a new client with default transport settings.

Port and token are discovered per-request, so the client works even if the daemon isn’t running at creation time.

Source

pub fn with_config(config: TransportConfig) -> Self

Create a new client with explicit transport configuration.

Source§

impl Client

Local API methods.

Source

pub async fn status(&self) -> Result<Status, Error>

Get the current tailscaled status.

Source

pub async fn status_without_peers(&self) -> Result<Status, Error>

Get the current tailscaled status without peer information.

Source

pub async fn who_is(&self, remote_addr: &str) -> Result<WhoIsResponse, Error>

Look up the owner of an IP address, IP:port, or node key.

Returns Error::PeerNotFound if the peer is not found (HTTP 404).

Source

pub async fn who_is_node_key( &self, node_key: &str, ) -> Result<WhoIsResponse, Error>

Look up a peer by node key.

Source

pub async fn who_is_proto( &self, proto: &str, remote_addr: &str, ) -> Result<WhoIsResponse, Error>

Look up the owner of an IP address with a specific protocol.

The proto parameter should be “tcp” or “udp”.

Source

pub async fn cert_pair(&self, domain: &str) -> Result<(Vec<u8>, Vec<u8>), Error>

Get a TLS certificate and private key for the given domain. Returns (cert_pem, key_pem).

Source

pub async fn cert_pair_with_validity( &self, domain: &str, min_validity_secs: u64, ) -> Result<(Vec<u8>, Vec<u8>), Error>

Get a TLS certificate with minimum validity duration (in seconds). Returns (cert_pem, key_pem).

Source

pub async fn get_serve_config(&self) -> Result<ServeConfig, Error>

Get the current serve config.

The returned ServeConfig has its e_tag field populated from the HTTP Etag response header.

Source

pub async fn set_serve_config(&self, config: &ServeConfig) -> Result<(), Error>

Set the serve config.

The e_tag field on the config is sent as the If-Match header for conditional updates.

Trait Implementations§

Source§

impl Clone for Client

Source§

fn clone(&self) -> Client

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Client

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Client

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

fn clone_into(&self, target: &mut T)

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more