Enum snarkos_metrics::Unit

source · [−]

pub enum Unit {
Show 17 variants    Count,
    Percent,
    Seconds,
    Milliseconds,
    Microseconds,
    Nanoseconds,
    Tebibytes,
    Gigibytes,
    Mebibytes,
    Kibibytes,
    Bytes,
    TerabitsPerSecond,
    GigabitsPerSecond,
    MegabitsPerSecond,
    KilobitsPerSecond,
    BitsPerSecond,
    CountPerSecond,
}

Expand description

Units for a given metric.

While metrics do not necessarily need to be tied to a particular unit to be recorded, some downstream systems natively support defining units and so they can be specified during registration.

Variants

`Count`

Count.

`Percent`

Percentage.

`Seconds`

Seconds.

One second is equal to 1000 milliseconds.

`Milliseconds`

Milliseconds.

One millisecond is equal to 1000 microseconds.

`Microseconds`

Microseconds.

One microsecond is equal to 1000 nanoseconds.

`Nanoseconds`

Nanoseconds.

`Tebibytes`

Tebibytes.

One tebibyte is equal to 1024 gigibytes.

`Gigibytes`

Gigibytes.

One gigibyte is equal to 1024 mebibytes.

`Mebibytes`

Mebibytes.

One mebibyte is equal to 1024 kibibytes.

`Kibibytes`

Kibibytes.

One kibibyte is equal to 1024 bytes.

`Bytes`

Bytes.

`TerabitsPerSecond`

Terabits per second.

One terabit is equal to 1000 gigabits.

`GigabitsPerSecond`

Gigabits per second.

One gigabit is equal to 1000 megabits.

`MegabitsPerSecond`

Megabits per second.

One megabit is equal to 1000 kilobits.

`KilobitsPerSecond`

Kilobits per second.

One kilobit is equal to 1000 bits.

`BitsPerSecond`

Bits per second.

`CountPerSecond`

Count per second.

Implementations

impl Unit

pub fn as_str(&self) -> &str

Gets the string form of this Unit.

pub fn as_canonical_label(&self) -> &str

Gets the canonical string label for the given unit.

For example, the canonical label for Seconds would be s, while for Nanoseconds, it would be ns.

Not all units have a meaningful display label and so some may be empty.

pub fn from_string(s: &str) -> Option<Unit>

Converts the string representation of a unit back into Unit if possible.

The value passed here should match the output of Unit::as_str.

pub fn is_time_based(&self) -> bool

Whether or not this unit relates to the measurement of time.

pub fn is_data_based(&self) -> bool

Whether or not this unit relates to the measurement of data.

pub fn is_data_rate_based(&self) -> bool

Whether or not this unit relates to the measurement of data rates.

Trait Implementations

impl Clone for Unit

pub fn clone(&self) -> Unit

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl Debug for Unit

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

Formats the value using the given formatter. Read more

impl PartialEq<Unit> for Unit

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

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0 · source

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

This method tests for !=.

impl Copy for Unit

impl StructuralPartialEq for Unit

Auto Trait Implementations

impl RefUnwindSafe for Unit

impl Send for Unit

impl Sync for Unit

impl Unpin for Unit

impl UnwindSafe for Unit

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Performs the conversion.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

const: unstable · source

pub fn into(self) -> U

Performs the conversion.

impl<T> Pointable for T

pub const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

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

Initializes a with the given initializer. Read more

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

Dereferences the given pointer. Read more

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

Mutably dereferences the given pointer. Read more

pub unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

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

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

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

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

Uses borrowed data to replace owned data, usually by cloning. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more