noxious_client

Struct Proxy

Source
pub struct Proxy {
    pub config: ProxyConfig,
    /* private fields */
}
Expand description

A proxy object returned by the Client. To manipulate this proxy and manipulate the toxics, you can call methods on this object.

Fields§

§config: ProxyConfig

Contains the proxy listen and upstream address, name. You can mutate them and call .save() to update the proxy.

Implementations§

Source§

impl Proxy

Source

pub async fn save(&mut self) -> Result<(), ClientError>

Save saves changes to a proxy such as its enabled status or upstream port. Note: this does not update the toxics

Source

pub async fn enable(&mut self) -> Result<(), ClientError>

Enable a proxy again after it has been disabled

Source

pub async fn disable(&mut self) -> Result<(), ClientError>

Disable a proxy so that no connections can pass through. This will drop all active connections.

Source

pub fn is_enabled(&self) -> bool

Returns whether this proxy is enabled or not

Source

pub async fn change_name(&mut self, new_name: &str) -> Result<(), ClientError>

Give this proxy a new name, save it.

Source

pub async fn delete(self) -> Result<(), ClientError>

Delete a proxy complete and close all existing connections through it. All information about the proxy such as listen port and active toxics will be deleted as well. If you just wish to stop and later enable a proxy, use enable() and disable().

Source

pub async fn toxics(&self) -> Result<Vec<Toxic>, ClientError>

Returns a map of all active toxics and their attributes

Source

pub async fn add_toxic(&self, toxic: &Toxic) -> Result<Toxic, ClientError>

Add a new toxic to this proxy.

§Example
use noxious_client::{Client, Toxic, ToxicKind, StreamDirection};

#[tokio::main]
async fn main() {
    let toxic = Toxic {
        kind: ToxicKind::Latency { latency: 40, jitter: 5 },
        name: "myProxy_latency".to_owned(),
        toxicity: 0.9,
        direction: StreamDirection::Upstream,
    };

    let client = Client::new("127.0.0.1:8474");
    let result = client.add_toxic(&toxic).await;
}
Source

pub async fn update_toxic( &self, name: &str, toxicity: f32, kind: ToxicKind, direction: StreamDirection, ) -> Result<Toxic, ClientError>

Updates a toxic with the given name If toxicity is below zero, it will be sent as 0

Source

pub async fn remove_toxic(&self, name: &str) -> Result<(), ClientError>

Removes a toxic with the given name

Trait Implementations§

Source§

impl Clone for Proxy

Source§

fn clone(&self) -> Proxy

Returns a copy 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 Proxy

Source§

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

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

impl PartialEq for Proxy

Source§

fn eq(&self, other: &Proxy) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for Proxy

Auto Trait Implementations§

§

impl Freeze for Proxy

§

impl RefUnwindSafe for Proxy

§

impl Send for Proxy

§

impl Sync for Proxy

§

impl Unpin for Proxy

§

impl UnwindSafe for Proxy

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, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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,

Source§

impl<T> MaybeSendSync for T