Enum Toxic 

pub enum Toxic {
    Latency {
        latency: u64,
        jitter: u64,
    },
    Bandwidth {
        rate: u64,
    },
    Timeout {
        timeout: u64,
    },
    Slicer {
        average_size: u64,
        size_variation: u64,
        delay: u64,
    },
    LimitData {
        bytes: u64,
    },
}

A typed Toxiproxy toxic.

Each variant maps to a Toxiproxy toxic type and carries its attributes. Use the associated constructors (Toxic::latency, Toxic::bandwidth, …) to build a toxic, then pass it to ToxiproxyTemplate::add_toxic.

See the Toxiproxy toxics reference for the full semantics of each type.

Variants

Latency

Add a delay to all data, with optional random jitter.

latency and jitter are in milliseconds.

Fields

latency: u64

Base latency added to each packet, in milliseconds.

jitter: u64

Random jitter added on top of the base latency, in milliseconds.

Bandwidth

Limit the connection to a maximum throughput.

rate is in kilobytes per second.

Fields

rate: u64

Throughput limit in kilobytes per second.

Timeout

Stop all data and close the connection after timeout milliseconds.

A timeout of 0 holds the connection open indefinitely without passing data, which is useful for simulating a hung upstream.

Fields

timeout: u64

Time to wait before closing the connection, in milliseconds.

Slicer

Slice data into smaller packets to simulate fragmentation.

Fields

average_size: u64

Average size of each packet, in bytes.

size_variation: u64

Variation in packet size, in bytes.

delay: u64

Delay between sliced packets, in microseconds.

LimitData

Close the connection after a fixed number of bytes have been transmitted.

Fields

bytes: u64

Number of bytes to allow before closing the connection.

Implementations

impl Toxic

pub fn latency(latency: u64) -> Self

Create a latency toxic with no jitter.

latency is in milliseconds.

pub fn jitter(latency: u64, jitter: u64) -> Self

Create a latency toxic with random jitter.

Both latency and jitter are in milliseconds.

pub fn bandwidth(rate: u64) -> Self

Create a bandwidth toxic limiting throughput to rate kilobytes per second.

pub fn timeout(timeout: u64) -> Self

Create a timeout toxic that closes the connection after timeout milliseconds.

A timeout of 0 holds the connection open indefinitely.

pub fn slicer(average_size: u64, size_variation: u64, delay: u64) -> Self

Create a slicer toxic that fragments data into smaller packets.

average_size and size_variation are in bytes; delay is in microseconds.

pub fn limit_data(bytes: u64) -> Self

Create a limit_data toxic that closes the connection after bytes bytes.

Trait Implementations

impl Clone for Toxic

fn clone(&self) -> Toxic

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Toxic

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

Formats the value using the given formatter.

impl PartialEq for Toxic

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for Toxic