Struct Frequency 

pub struct Frequency(pub u64);

A radio frequency in Hertz.

Frequencies are stored and serialized as Hertz (Hz) as required by TrackAudio, but can be constructed from Megahertz (MHz) or Kilohertz (kHz) for convenience.

Examples

use trackaudio::Frequency;

// Construct from MHz
let freq = Frequency::from_mhz(132.600);
assert_eq!(freq, Frequency(132_600_000));
assert_eq!(freq.as_hz(), 132_600_000);
assert_eq!(freq.as_khz(), 132_600);
assert_eq!(freq.as_mhz(), 132.600);

// Construct from kHz
let freq = Frequency::from_khz(132_600);
assert_eq!(freq, Frequency(132_600_000));
assert_eq!(freq.as_hz(), 132_600_000);
assert_eq!(freq.as_khz(), 132_600);
assert_eq!(freq.as_mhz(), 132.600);

// Construct from Hz directly
let freq = Frequency::from_hz(132_600_000);
assert_eq!(freq, Frequency(132_600_000));
assert_eq!(freq.as_hz(), 132_600_000);
assert_eq!(freq.as_khz(), 132_600);
assert_eq!(freq.as_mhz(), 132.600);

// Convert from u64 (Hertz)
let freq: Frequency = 132_600_000.into();
assert_eq!(freq, Frequency(132_600_000));
assert_eq!(freq.as_hz(), 132_600_000);
assert_eq!(freq.as_khz(), 132_600);
assert_eq!(freq.as_mhz(), 132.600);

// Convert to u64 (Hertz)
let hz: u64 = Frequency::from_mhz(132.600).into();
assert_eq!(hz, 132_600_000);

// Convert from f64 (Megahertz)
let freq: Frequency = 132.6f64.into();
assert_eq!(freq, Frequency(132_600_000));
assert_eq!(freq.as_hz(), 132_600_000);
assert_eq!(freq.as_khz(), 132_600);
assert_eq!(freq.as_mhz(), 132.600);

// Convert to f64 (Megahertz)
let mhz: f64 = Frequency::from_mhz(132.600).into();
assert_eq!(mhz, 132.600f64);

Tuple Fields

0: u64

Implementations

impl Frequency

pub const fn from_hz(hz: u64) -> Self

Creates a Frequency from Hertz (Hz).

This is the same as constructing the type directly, as the frequency is stored in Hertz internally.

Examples

use trackaudio::Frequency;

let freq = Frequency::from_hz(132_600_000);
assert_eq!(freq, Frequency(132_600_000));
assert_eq!(freq.as_hz(), 132_600_000);
assert_eq!(freq.as_khz(), 132_600);
assert_eq!(freq.as_mhz(), 132.600);

pub const fn from_khz(khz: u64) -> Self

Creates a Frequency from Kilohertz (kHz).

Examples

use trackaudio::Frequency;

let freq = Frequency::from_khz(132_600);
assert_eq!(freq, Frequency(132_600_000));
assert_eq!(freq.as_hz(), 132_600_000);
assert_eq!(freq.as_khz(), 132_600);
assert_eq!(freq.as_mhz(), 132.600);

pub fn from_mhz(mhz: f64) -> Self

Creates a Frequency from Megahertz (MHz).

Examples

use trackaudio::Frequency;

let freq = Frequency::from_mhz(132.600);
assert_eq!(freq, Frequency(132_600_000));
assert_eq!(freq.as_hz(), 132_600_000);
assert_eq!(freq.as_khz(), 132_600);
assert_eq!(freq.as_mhz(), 132.600);

pub const fn as_hz(&self) -> u64

Returns the frequency in Hertz (Hz).

This is the same as accessing the underlying type, as the frequency is stored in Hertz internally.

pub const fn as_khz(&self) -> u64

Returns the frequency in Kilohertz (kHz).

pub fn as_mhz(&self) -> f64

Returns the frequency in Megahertz (MHz).

Trait Implementations

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<'de> Deserialize<'de> for Frequency

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Frequency

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

Formats the value using the given formatter.

impl From<Frequency> for f64

fn from(freq: Frequency) -> Self

Converts to this type from the input type.

impl From<Frequency> for u64

fn from(freq: Frequency) -> Self

Converts to this type from the input type.

impl From<f64> for Frequency

fn from(mhz: f64) -> Self

Converts to this type from the input type.

impl From<u64> for Frequency

fn from(hz: u64) -> Self

Converts to this type from the input type.

impl Hash for Frequency

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Frequency

fn cmp(&self, other: &Frequency) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

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 Serialize for Frequency

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Frequency

impl Eq for Frequency

impl StructuralPartialEq for Frequency