Struct Client

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

Implementations§

Source§

impl Client

Source

pub fn new(baseurl: &str) -> Self

Source

pub fn new_with_client(baseurl: &str, client: Client) -> Self

Source

pub fn baseurl(&self) -> &String

Source

pub fn client(&self) -> &Client

Source

pub async fn get_controller_status<'a>( &'a self, ) -> Result<ResponseValue<ControllerStatus>, Error<()>>

Get Controller Status

Check for controller function and return controller status.

Sends a GET request to /controller

Source

pub async fn get_controller_networks<'a>( &'a self, ) -> Result<ResponseValue<Vec<String>>, Error<()>>

List Networks

List IDs of all networks hosted by this controller.

Sends a GET request to /controller/network

Source

pub async fn get_controller_network<'a>( &'a self, network_id: &'a str, ) -> Result<ResponseValue<ControllerNetwork>, Error<()>>

Get Network by ID

Get details of a network by it’s ID.

Sends a GET request to /controller/network/{networkID}

Arguments:

  • network_id: ID of the network.
Source

pub async fn set_controller_network<'a>( &'a self, network_id: &'a str, body: &'a ControllerNetwork, ) -> Result<ResponseValue<ControllerNetwork>, Error<()>>

Create or Update a Network

Sends a POST request to /controller/network/{networkID}

Arguments:

  • network_id: ID of the network.
  • body: Network object JSON.
Source

pub async fn generate_controller_network<'a>( &'a self, controller_id: &'a str, body: &'a ControllerNetwork, ) -> Result<ResponseValue<ControllerNetwork>, Error<()>>

Generate Random Network ID

Create a new network with a random ID.

Sends a POST request to /controller/network/{controllerID}

Arguments:

  • controller_id: Node ID of the controller.
  • body: Network object JSON.
Source

pub async fn get_controller_network_members<'a>( &'a self, network_id: &'a str, ) -> Result<ResponseValue<HashMap<String, i64>>, Error<()>>

List Network Members

JSON object containing all member IDs as keys and their memberRevisionCounter values as values.

Sends a GET request to /controller/network/{networkID}/member

Arguments:

  • network_id: ID of the network.
Source

pub async fn get_controller_network_member<'a>( &'a self, network_id: &'a str, node_id: &'a str, ) -> Result<ResponseValue<ControllerNetworkMember>, Error<()>>

Get Network Member Details by ID

Sends a GET request to /controller/network/{networkID}/member/{nodeID}

Arguments:

  • network_id: ID of the network.
  • node_id: ID of the member node.
Source

pub async fn get_status<'a>( &'a self, ) -> Result<ResponseValue<Status>, Error<()>>

Node status and addressing info

Sends a GET request to /status

Source

pub async fn get_networks<'a>( &'a self, ) -> Result<ResponseValue<Vec<Network>>, Error<()>>

Get all network memberships

Sends a GET request to /network

Source

pub async fn get_network<'a>( &'a self, network_id: &'a str, ) -> Result<ResponseValue<Network>, Error<()>>

Get a joined Network membership configuration by Network ID

Sends a GET request to /network/{networkID}

Arguments:

  • network_id: ID of the network to get.
Source

pub async fn update_network<'a>( &'a self, network_id: &'a str, body: &'a Network, ) -> Result<ResponseValue<Network>, Error<()>>

Join a network or update it’s configuration by Network ID

Sends a POST request to /network/{networkID}

Arguments:

  • network_id: ID of the network to change.
  • body: Network membership object
Source

pub async fn delete_network<'a>( &'a self, network_id: &'a str, ) -> Result<ResponseValue<()>, Error<()>>

Leave a network

Sends a DELETE request to /network/{networkID}

Arguments:

  • network_id: ID of the network
Source

pub async fn get_peers<'a>( &'a self, ) -> Result<ResponseValue<Vec<Peer>>, Error<()>>

Get all peers

Sends a GET request to /peer

Source

pub async fn get_peer<'a>( &'a self, address: &'a str, ) -> Result<ResponseValue<Peer>, Error<()>>

Get information about a specific peer by Node ID

Sends a GET request to /peer/{address}

Arguments:

  • address: ZeroTier address of the peer to get

Trait Implementations§

Source§

impl Clone for Client

Source§

fn clone(&self) -> Client

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

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

impl Freeze for Client

§

impl !RefUnwindSafe for Client

§

impl Send for Client

§

impl Sync for Client

§

impl Unpin for Client

§

impl !UnwindSafe for Client

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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
Source§

impl<T> ErasedDestructor for T
where T: 'static,