Struct NetBenchTest 

pub struct NetBenchTest { /* private fields */ }

A running benchmark.

Implementations

impl NetBenchTest

pub async fn next(&mut self) -> Option<NetBenchEvent>

Waits for the next progress event.

pub fn cancel(&self)

Cancels the benchmark task without closing the caller-owned connection.

Call Self::abort_and_wait when the caller must prove that the internal task has exited.

pub fn is_finished(&self) -> bool

Returns whether the internal benchmark task has finished.

pub async fn abort_and_wait(self) -> Result<()>

Cancels the benchmark and waits until its internal task has exited.

Errors

Returns an error if the task panicked while cancellation was racing with completion.

pub async fn result(self) -> Result<NetBenchReport>

Waits for the final report.

Errors

Returns the terminal error from the benchmark task.

Trait Implementations

impl Debug for NetBenchTest

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

Formats the value using the given formatter.

impl Drop for NetBenchTest

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.