Struct toxiproxy_rust::TOXIPROXY

pub struct TOXIPROXY { /* fields omitted */ }

Pre-built client using the default connection address.

Methods from Deref<Target = Client>

pub fn populate(&self, proxies: Vec<ProxyPack>) -> Result<Vec<Proxy>, String>

Establish a set of proxies to work with.

Examples

let client = Client::new("127.0.0.1:8474");
let proxies = client.populate(vec![ProxyPack::new(
    "socket".into(),
    "localhost:2001".into(),
    "localhost:2000".into(),
)]).expect("populate has completed");

let proxies = toxiproxy_rust::TOXIPROXY.populate(vec![toxiproxy_rust::proxy::ProxyPack::new(
    "socket".into(),
    "localhost:2001".into(),
    "localhost:2000".into(),
)]).expect("populate has completed");

pub fn reset(&self) -> Result<(), String>

Enable all proxies and remove all active toxics.

Examples

let client = Client::new("127.0.0.1:8474");
client.reset();

toxiproxy_rust::TOXIPROXY.reset();

pub fn all(&self) -> Result<HashMap<String, Proxy>, String>

Returns all registered proxies and their toxics.

Examples

let proxies = toxiproxy_rust::TOXIPROXY.all().expect("all proxies were fetched");

pub fn is_running(&self) -> bool

Health check for the Toxiproxy server.

Examples

if !toxiproxy_rust::TOXIPROXY.is_running() {
    /* signal the problem */
}

pub fn version(&self) -> Result<String, String>

Version of the Toxiproxy server.

Examples

let version = toxiproxy_rust::TOXIPROXY.version().expect("version is returned");

pub fn find_and_reset_proxy(&self, name: &str) -> Result<Proxy, String>

Fetches a proxy a resets its state (remove active toxics). Usually a good way to start a test and to start setting up toxics fresh against the proxy.

Examples

let proxy = toxiproxy_rust::TOXIPROXY.find_and_reset_proxy("socket").expect("proxy returned");

pub fn find_proxy(&self, name: &str) -> Result<Proxy, String>

Fetches a proxy. Useful to fetch a proxy for a test where more fine grained control is required over a proxy and its toxics.

Examples

let proxy = toxiproxy_rust::TOXIPROXY.find_proxy("socket").expect("proxy returned");

Trait Implementations

impl Deref for TOXIPROXY

type Target = Client

The resulting type after dereferencing.

fn deref(&self) -> &Client

Dereferences the value.

impl LazyStatic for TOXIPROXY

fn initialize(lazy: &Self)