Struct Frequency 

pub struct Frequency(/* private fields */);

A frequency quantity, stored internally in hertz (Hz).

Construction

let f = Frequency::from_ghz(2.4);

Typed arithmetic

Supports .period() → Time and .wavelength() → Length (vacuum).

Implementations

impl Frequency

pub const fn from_hz(val: f64) -> Self

Create from hertz (canonical unit).

pub const fn from_khz(val: f64) -> Self

Create from kilohertz. 1 kHz = 1e3 Hz.

pub const fn from_mhz(val: f64) -> Self

Create from megahertz. 1 MHz = 1e6 Hz.

pub const fn from_ghz(val: f64) -> Self

Create from gigahertz. 1 GHz = 1e9 Hz.

pub const fn from_thz(val: f64) -> Self

Create from terahertz. 1 THz = 1e12 Hz.

pub const fn from_rpm(val: f64) -> Self

Create from revolutions per minute. 1 rpm = 1/60 Hz.

pub const fn in_hz(self) -> f64

Get value in hertz.

pub const fn in_khz(self) -> f64

Get value in kilohertz.

pub const fn in_mhz(self) -> f64

Get value in megahertz.

pub const fn in_ghz(self) -> f64

Get value in gigahertz.

pub const fn in_thz(self) -> f64

Get value in terahertz.

pub const fn in_rpm(self) -> f64

Get value in revolutions per minute.

pub fn in_unit(self, unit: FrequencyUnit) -> f64

Get value in the specified FrequencyUnit.

pub fn display_as(self, unit: FrequencyUnit) -> DisplayWithUnit

Return a display wrapper that formats this frequency in the given unit.

pub fn period(self) -> Time

Compute the period (1/f) as a Time.

pub fn wavelength(self) -> Length

Compute the wavelength in vacuum (c/f) as a Length.

pub fn abs(self) -> Self

Return the absolute value of this frequency.

Trait Implementations

impl Add for Frequency

type Output = Frequency

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self

Performs the + operation.

impl AddAssign for Frequency

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for Frequency

fn clone(&self) -> Frequency

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Frequency

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

Formats the value using the given formatter.

impl Default for Frequency

fn default() -> Frequency

Returns the “default value” for a type.

impl Display for Frequency

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

Formats the value using the given formatter.

impl Div<f64> for Frequency

type Output = Frequency

The resulting type after applying the / operator.

fn div(self, rhs: f64) -> Self

Performs the / operation.

impl Div for Frequency

type Output = f64

The resulting type after applying the / operator.

fn div(self, rhs: Self) -> f64

Performs the / operation.

impl DivAssign<f64> for Frequency

fn div_assign(&mut self, rhs: f64)

Performs the /= operation.

impl Mul<Frequency> for f64

type Output = Frequency

The resulting type after applying the * operator.

fn mul(self, rhs: Frequency) -> Frequency

Performs the * operation.

impl Mul<f64> for Frequency

type Output = Frequency

The resulting type after applying the * operator.

fn mul(self, rhs: f64) -> Self

Performs the * operation.

impl MulAssign<f64> for Frequency

fn mul_assign(&mut self, rhs: f64)

Performs the *= operation.

impl Neg for Frequency

type Output = Frequency

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl PartialEq for Frequency

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

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Sub for Frequency

type Output = Frequency

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self

Performs the - operation.

impl SubAssign for Frequency

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl Sum for Frequency

fn sum<I: Iterator<Item = Self>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by “summing up” the items.

impl Copy for Frequency

impl StructuralPartialEq for Frequency