Struct Hertz

pub struct Hertz(pub c_ulong);

The frequency unit.

Represents a frequency in hertz, wrapping a c_ulong value.

Examples

use kernel::clk::Hertz;

let hz = 1_000_000_000;
let rate = Hertz(hz);

assert_eq!(rate.as_hz(), hz);
assert_eq!(rate, Hertz(hz));
assert_eq!(rate, Hertz::from_khz(hz / 1_000));
assert_eq!(rate, Hertz::from_mhz(hz / 1_000_000));
assert_eq!(rate, Hertz::from_ghz(hz / 1_000_000_000));

Tuple Fields

0: c_ulong

Implementations

impl Hertz

pub fn from_khz(khz: c_ulong) -> Self

Create a new instance from kilohertz (kHz)

pub fn from_mhz(mhz: c_ulong) -> Self

Create a new instance from megahertz (MHz)

pub fn from_ghz(ghz: c_ulong) -> Self

Create a new instance from gigahertz (GHz)

pub fn as_hz(&self) -> c_ulong

Get the frequency in hertz

pub fn as_khz(&self) -> c_ulong

Get the frequency in kilohertz

pub fn as_mhz(&self) -> c_ulong

Get the frequency in megahertz

pub fn as_ghz(&self) -> c_ulong

Get the frequency in gigahertz

Trait Implementations

impl Clone for Hertz

fn clone(&self) -> Hertz

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Hertz

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

Formats the value using the given formatter.

impl From<Hertz> for c_ulong

fn from(freq: Hertz) -> Self

Converts to this type from the input type.

impl PartialEq for Hertz

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

impl Eq for Hertz

impl StructuralPartialEq for Hertz