Struct iroh_net_bench::Opt

pub struct Opt {
    pub clients: usize,
    pub streams: usize,
    pub max_streams: usize,
    pub download_size: u64,
    pub upload_size: u64,
    pub stats: bool,
    pub metrics: bool,
    pub read_unordered: bool,
    pub initial_mtu: u16,
    pub with_relay: bool,
}

Fields

clients: usize

The total number of clients which should be created

streams: usize

The total number of streams which should be created

max_streams: usize

The amount of concurrent streams which should be used

download_size: u64

Number of bytes to transmit from server to client

This can use SI prefixes for sizes. E.g. 1M will transfer 1MiB, 10G will transfer 10GiB.

upload_size: u64

Number of bytes to transmit from client to server

This can use SI prefixes for sizes. E.g. 1M will transfer 1MiB, 10G will transfer 10GiB.

stats: bool

Show connection stats the at the end of the benchmark

metrics: bool

Show iroh library counter metrics at the end of the benchmark

These metrics are process-wide, so contain metrics for clients and the server all summed up.

read_unordered: bool

Whether to use the unordered read API

initial_mtu: u16

Starting guess for maximum UDP payload size

with_relay: bool

Whether to run a local relay and have the server and clients connect to that.

Can be combined with the DEV_RELAY_ONLY environment variable (at compile time) to test throughput for relay-only traffic locally. (e.g. DEV_RELAY_ONLY=true cargo run --release -- iroh --with-relay)

Trait Implementations

impl Args for Opt

fn group_id() -> Option<Id>

Report the [ArgGroup::id][crate::ArgGroup::id] for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate Self via [FromArgMatches::from_arg_matches_mut]

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate self via [FromArgMatches::update_from_arg_matches_mut]

impl Clone for Opt

fn clone(&self) -> Opt

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CommandFactory for Opt

fn command<'b>() -> Command

Build a [Command] that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a [Command] that can update self.

impl Debug for Opt

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

Formats the value using the given formatter.

impl FromArgMatches for Opt

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches ) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for Opt

fn parse() -> Self

Parse from std::env::args_os(), [exit][Error::exit] on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, [exit][Error::exit] on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, [exit][Error::exit] on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.

impl Copy for Opt