Enum codspeed_criterion_compat::Throughput

pub enum Throughput {
    Bytes(u64),
    BytesDecimal(u64),
    Elements(u64),
}

Enum representing different ways of measuring the throughput of benchmarked code. If the throughput setting is configured for a benchmark then the estimated throughput will be reported as well as the time per iteration.

Variants

Bytes(u64)

Measure throughput in terms of bytes/second. The value should be the number of bytes processed by one iteration of the benchmarked code. Typically, this would be the length of an input string or &[u8].

BytesDecimal(u64)

Equivalent to Bytes, but the value will be reported in terms of kilobytes (1000 bytes) per second instead of kibibytes (1024 bytes) per second, megabytes instead of mibibytes, and gigabytes instead of gibibytes.

Elements(u64)

Measure throughput in terms of elements/second. The value should be the number of elements processed by one iteration of the benchmarked code. Typically, this would be the size of a collection, but could also be the number of lines of input text or the number of values to parse.

Trait Implementations

impl Clone for Throughput

fn clone(&self) -> Throughput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Throughput

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Throughput

fn deserialize<__D>( __deserializer: __D, ) -> Result<Throughput, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Throughput

fn eq(&self, other: &Throughput) -> 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 Serialize for Throughput

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Throughput

impl StructuralPartialEq for Throughput