Struct femtos::Frequency

pub struct Frequency { /* private fields */ }

Represents a frequency in Hz

Clocks are usually given as a frequency, but durations are needed when dealing with clocks and clock durations. This type makes it easier to create a clock of a given frequency and convert it to a Duration

Implementations

impl Frequency

pub const fn from_hz(hertz: u32) -> Self

Creates a new Frequency from the specified number of hertz

Examples

use femtos::Frequency;

Frequency::from_hz(123);

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

Creates a new Frequency from the specified number of kilohertz

Examples

use femtos::Frequency;

Frequency::from_khz(123);

pub const fn from_mhz(mhz: u32) -> Self

Creates a new Frequency from the specified number of megahertz

Examples

use femtos::Frequency;

Frequency::from_mhz(123);

pub const fn as_hz(self) -> u32

Returns the frequency is hertz

pub const fn as_khz(self) -> u32

Returns the frequency is kilohertz

pub const fn as_mhz(self) -> u32

Returns the frequency is megahertz

pub const fn period_duration(self) -> Duration

Returns the Duration equivalent to the time period between cycles of the given Frequency

Examples

use femtos::{Duration, Frequency};

assert_eq!(Frequency::from_hz(1).period_duration(), Duration::from_secs(1));

Trait Implementations

impl Clone for Frequency

fn clone(&self) -> Frequency

Returns a copy 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 Div<u32> for Frequency

type Output = Frequency

The resulting type after applying the / operator.

fn div(self, rhs: u32) -> Self::Output

Performs the / operation.

impl DivAssign<u32> for Frequency

fn div_assign(&mut self, rhs: u32)

Performs the /= operation.

impl Mul<u32> for Frequency

type Output = Frequency

The resulting type after applying the * operator.

fn mul(self, rhs: u32) -> Self::Output

Performs the * operation.

impl MulAssign<u32> for Frequency

fn mul_assign(&mut self, rhs: u32)

Performs the *= operation.

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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Frequency

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

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

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

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

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

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

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

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

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

impl Eq for Frequency

impl StructuralPartialEq for Frequency