Skip to main content

Benchmark

Struct Benchmark 

Source
pub struct Benchmark { /* private fields */ }
Expand description

A configured benchmark ready to run.

Create a Benchmark using Benchmark::builder() and then execute it with run().

§Examples

let results = Benchmark::builder()
    .url("http://localhost:3000")
    .concurrency(50)
    .duration(Duration::from_secs(10))
    .build()?
    .run()
    .await?;

results.print();

Implementations§

Source§

impl Benchmark

Source

pub fn builder() -> BenchmarkBuilder

Create a new benchmark builder.

This is the entry point for configuring and running benchmarks.

§Examples
use httpress::Benchmark;

let builder = Benchmark::builder();
Source

pub async fn run(self) -> Result<BenchmarkResults>

Run the benchmark and return results.

Executes the configured benchmark, blocking until completion or interruption (Ctrl+C). Returns detailed metrics including latency statistics, throughput, and status codes.

§Errors

Returns an error if:

  • The HTTP client cannot be initialized
  • Network errors occur during execution (wrapped in results, not returned as error)
§Examples
let benchmark = Benchmark::builder()
    .url("http://localhost:3000")
    .requests(1000)
    .build()?;

let results = benchmark.run().await?;

println!("Throughput: {:.2} req/s", results.throughput);
println!("p99 latency: {:?}", results.latency_p99);

Auto Trait Implementations§

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> 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, 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<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