Struct clashctl_core::Clash

pub struct Clash { /* fields omitted */ }

Clash API

Use struct Clash for interacting with Clash RESTful API. For more information, check https://github.com/Dreamacro/clash/wiki/external-controller-API-reference###Proxies, or maybe just read source code of clash

Implementations

impl Clash

pub fn builder<S: Into<String>>(url: S) -> Result<ClashBuilder>

pub fn new(url: Url) -> Self

pub fn oneshot_req_with_body(
    &self,
    endpoint: &str,
    method: &str,
    body: Option<String>
) -> Result<String>

Send a oneshot request to the specific endpoint with method, with body

pub fn oneshot_req(&self, endpoint: &str, method: &str) -> Result<String>

Send a oneshot request to the specific endpoint with method, without body

pub fn longhaul_req<T: DeserializeOwned>(
    &self,
    endpoint: &str,
    method: &str
) -> Result<LongHaul<T>>

Send a longhaul request to the specific endpoint with method, Underlying is an http stream with chunked-encoding.

Use LongHaul::next_item, LongHaul::next_raw or Iterator::next to retreive data

Examplel

let traffics = clash.longhaul_req::<Traffic>("traffic", "GET").expect("connect failed");

// LongHaul implements `Iterator` so you can use iterator combinators
for traffic in traffics.take(3) {
    println!("{:#?}", traffic)
}

pub fn get<T: DeserializeOwned>(&self, endpoint: &str) -> Result<T>

Helper function for method GET

pub fn delete(&self, endpoint: &str) -> Result<()>

Helper function for method DELETE

pub fn put<T: DeserializeOwned>(
    &self,
    endpoint: &str,
    body: Option<String>
) -> Result<T>

Helper function for method PUT

pub fn get_version(&self) -> Result<Version>

Get clash version

pub fn get_configs(&self) -> Result<Config>

Get base configs

pub fn reload_configs(&self, force: bool, path: &str) -> Result<()>

Reloading base configs.

• force: will change ports etc.,
• path: the absolute path to config file

This will NOT affect external-controller & secret

pub fn get_proxies(&self) -> Result<Proxies>

Get proxies information

pub fn get_rules(&self) -> Result<Rules>

Get rules information

pub fn get_proxy(&self, proxy: &str) -> Result<Proxy>

Get specific proxy information

pub fn get_connections(&self) -> Result<Connections>

Get connections information

pub fn close_connections(&self) -> Result<()>

Close all connections

pub fn close_one_connection(&self, id: &str) -> Result<()>

Close specific connection

pub fn get_traffic(&self) -> Result<LongHaul<Traffic>>

Get real-time traffic data

Note: This is a longhaul request, which will last forever until interrupted or disconnected.

See longhaul_req for more information

pub fn get_log(&self) -> Result<LongHaul<Log>>

Get real-time logs

Note: This is a longhaul request, which will last forever until interrupted or disconnected.

See longhaul_req for more information

pub fn get_proxy_delay(
    &self,
    proxy: &str,
    test_url: &str,
    timeout: u64
) -> Result<Delay>

Get specific proxy delay test information

pub fn set_proxygroup_selected(&self, group: &str, proxy: &str) -> Result<()>

Select specific proxy

Trait Implementations

impl Clone for Clash

fn clone(&self) -> Clash

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Clash

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

Formats the value using the given formatter.