Enum Throughput

Source

pub enum Throughput {
    Bits(u64),
    Bytes(u64),
    BytesDecimal(u64),
    Elements(u64),
    ElementsAndBytes {
        elements: u64,
        bytes: u64,
    },
}

Expand description

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§

§

Bits(u64)

Measure throughput in terms of bits/second. The value should be the number of bits processed by one iteration of the benchmarked code. Typically, this would be the number of bits transferred by a networking function.

§

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.

§

ElementsAndBytes

Measure throughput in terms of both elements/second and bytes/second. Typically, this would be used if you have a collection of rows where elements would be the length of the collection and bytes would be the total size of the collection if you’re processing the entire collection in one iteration. This will make sure the report simultaneously includes on the rows/s and MB/s that data processing is able to achieve. The elements are considered the “primary” throughput being reported on (i.e. what will appear in the BenchmarkId).

Fields

§elements: u64

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.

§bytes: u64

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].

Throughput

Enum Throughput Copy item path

Variants§

Bits(u64)

Bytes(u64)

BytesDecimal(u64)

Elements(u64)

ElementsAndBytes

Fields

Trait Implementations§

impl Clone for Throughput

fn clone(&self) -> Throughput

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

impl Debug for Throughput

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

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

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

impl PartialEq for Throughput

fn eq(&self, other: &Throughput) -> bool

fn ne(&self, other: &Rhs) -> bool

impl Serialize for Throughput

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

impl Eq for Throughput

impl StructuralPartialEq for Throughput

Auto Trait Implementations§

impl Freeze for Throughput

impl RefUnwindSafe for Throughput

impl Send for Throughput

impl Sync for Throughput

impl Unpin for Throughput

impl UnwindSafe for Throughput

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> CloneToUninit for Twhere T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>where F: FnOnce(&Self) -> bool,

impl<T> Pointable for T

const ALIGN: usize

type Init = T

unsafe fn init(init: <T as Pointable>::Init) -> usize

unsafe fn deref<'a>(ptr: usize) -> &'a T

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

unsafe fn drop(ptr: usize)

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> DeserializeOwned for Twhere T: for<'de> Deserialize<'de>,

Enum Throughput

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

impl<T> Any for T
where T: 'static + ?Sized,

impl<T> Borrow<T> for T
where T: ?Sized,

impl<T> BorrowMut<T> for T
where T: ?Sized,

impl<T> CloneToUninit for T
where T: Clone,

impl<T, U> Into<U> for T
where U: From<T>,

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

impl<T> ToOwned for T
where T: Clone,

impl<T, U> TryFrom<U> for T
where U: Into<T>,

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,