Classes | |
| struct | ExampleOptions |
| Options the example runs with. More... | |
| struct | BenchmarkResult |
| The result of one benchmark pass. More... | |
Functions | |
| pub struct ExampleOptions | from_env () -> Option< Self > |
| Default options, reading the Enterprise file when its share is reachable and otherwise the free ASN file, which is far smaller to download than the Lite file and serves a benchmark as well. | |
| pub fn | for_tier (tier:examples_shared::IpiTier, max_ips:usize, iterations:usize,) -> Option< Self > |
| Options pinned to a specific data-file tier, IP cap and iteration count. | |
Variables | |
| const | CONTACT_US_URL |
| Where to ask about a copy of the Enterprise data file. | |
| const & | str |
| const | IPI_EVIDENCE_RELATIVE_PATH |
| The relative path to the IP-intelligence evidence file in the data submodule. | |
| const | ENTERPRISE_LISTED |
| Location properties only the Enterprise data file carries. | |
| const | Town |
| const | Latitude |
| const | Longitude |
| pub | data_file |
The full path to the .ipi data file to open. | |
| pub pub | evidence_file |
| The full path to the YAML evidence file to read. | |
| pub pub pub | thread_count |
| How many worker threads to run the multi-threaded pass with. | |
| pub pub pub pub | max_ips |
| The maximum number of distinct IP addresses to load from the evidence file. | |
| pub pub pub pub pub | iterations |
| How many times each thread loops over the loaded IP set. | |
| pub pub pub pub pub pub | json_output |
| Where to write the results JSON the nightly performance graphs read, if anywhere. | |
Function Documentation
◆ for_tier()
| pub fn for_tier | ( | tier:examples_shared::IpiTier | , |
| max_ips:usize | , | ||
| iterations:usize | ) -> Option< Self > |
Options pinned to a specific data-file tier, IP cap and iteration count.
The test pins the ASN tier and a tiny workload so it runs quickly and deterministically against the always-loadable ASN file.
◆ from_env()
| pub struct ExampleOptions from_env | ( | ) | -> Option< Self > |
Default options, reading the Enterprise file when its share is reachable and otherwise the free ASN file, which is far smaller to download than the Lite file and serves a benchmark as well.
The thread count is taken from the available parallelism.
Variable Documentation
◆ CONTACT_US_URL
| const CONTACT_US_URL |
Where to ask about a copy of the Enterprise data file.
◆ data_file
| pub data_file |
The full path to the .ipi data file to open.
◆ ENTERPRISE_LISTED
| const ENTERPRISE_LISTED |
Location properties only the Enterprise data file carries.
The timed lookups ask for Asn alone, so the figures stay comparable from run to run, and these are listed after them.
◆ evidence_file
| pub pub evidence_file |
The full path to the YAML evidence file to read.
◆ IPI_EVIDENCE_RELATIVE_PATH
| const IPI_EVIDENCE_RELATIVE_PATH |
The relative path to the IP-intelligence evidence file in the data submodule.
◆ iterations
| pub pub pub pub pub iterations |
How many times each thread loops over the loaded IP set.
◆ json_output
| pub pub pub pub pub pub json_output |
Where to write the results JSON the nightly performance graphs read, if anywhere.
CI passes --json-output <path>; an interactive run leaves it unset and only reads the printed figures.
◆ Latitude
| const Latitude |
◆ Longitude
| const Longitude |
◆ max_ips
| pub pub pub pub max_ips |
The maximum number of distinct IP addresses to load from the evidence file.
Each thread loops over the loaded set.
◆ str
| const & str |
◆ thread_count
| pub pub pub thread_count |
How many worker threads to run the multi-threaded pass with.
◆ Town
| const Town |
