Struct reaper_medium::Hz

pub struct Hz(_);

This represents a frequency measured in hertz (how often something happens per second).

Implementations

impl Hz

pub const MIN: Hz = _

The minimum frequency.

pub fn new(value: f64) -> Hz

Creates a hertz value.

Panics

This function panics if the given value zero or negative.

pub const unsafe fn new_unchecked(value: f64) -> Hz

Creates a hertz value without bound checking.

Safety

You must ensure that the given value is greater than 0.0.

pub const fn get(self) -> f64

Returns the wrapped value.

Trait Implementations

impl Clone for Hz

fn clone(&self) -> Hz

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Hz

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

Formats the value using the given formatter.

impl Default for Hz

fn default() -> Self

Returns the “default value” for a type.

impl Display for Hz

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

Formats the value using the given formatter.

impl Div<f64> for Hz

type Output = Option<Hz>

The resulting type after applying the / operator.

fn div(self, rhs: f64) -> Option<Hz>

Performs the / operation.

impl PartialEq<Hz> for Hz

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<Hz> for Hz

fn partial_cmp(&self, other: &Hz) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<f64> for Hz

type Error = TryFromGreaterError<f64>

The type returned in the event of a conversion error.

fn try_from(value: f64) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Hz

impl StructuralPartialEq for Hz