Skip to main content

Hertz

Struct Hertz

pub struct Hertz(pub c_ulong);

Expand description

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 const fn from_khz(khz: c_ulong) -> Self

Create a new instance from kilohertz (kHz)

§Panics

Panics if CONFIG_RUST_OVERFLOW_CHECKS is enabled and khz is greater than c_ulong::MAX / 1_000.

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

Create a new instance from megahertz (MHz)

§Panics

Panics if CONFIG_RUST_OVERFLOW_CHECKS is enabled and mhz is greater than c_ulong::MAX / 1_000_000.

pub const fn from_ghz(ghz: c_ulong) -> Self

Create a new instance from gigahertz (GHz)

§Panics

Panics if CONFIG_RUST_OVERFLOW_CHECKS is enabled and ghz is greater than c_ulong::MAX / 1_000_000_000.

pub const fn as_hz(&self) -> c_ulong

Get the frequency in hertz

pub const fn as_khz(&self) -> c_ulong

Get the frequency in kilohertz

pub const fn as_mhz(&self) -> c_ulong

Get the frequency in megahertz

pub const fn as_ghz(&self) -> c_ulong

Get the frequency in gigahertz

Trait Implementations§

impl Clone for Hertz

fn clone(&self) -> Self

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

impl Copy for Hertz

impl Debug for Hertz

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

Formats the value using the given formatter. Read more

impl Eq for Hertz

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: &Self) -> bool

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

impl StructuralPartialEq for Hertz

Auto Trait Implementations§

impl Freeze for Hertz

impl RefUnwindSafe for Hertz

impl Send for Hertz

impl Sync for Hertz

impl Unpin for Hertz

impl UnsafeUnpin for Hertz

impl UnwindSafe for Hertz

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Init<T> for T

fn chain<F>(self, f: F) -> ChainInit<Self, F, T, E>
where F: FnOnce(&mut T) -> Result<(), E>,

First initializes the value using self then calls the function f with the initialized value. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<S, T> IntoSafeCast<T> for S
where T: FromSafeCast<S>,

fn into_safe_cast(self) -> T

Convert self into a T. This operation is guaranteed to be lossless.

impl<S, T> IntoSafeCastArch<T> for S
where T: FromSafeCastArch<S>,

fn into_safe_cast_arch(self) -> T

Convert self into a T. This operation is guaranteed to be lossless.

impl<T> KnownSize for T

const MIN_SIZE: usize = const MIN_SIZE: usize = size_of::<T>();

Minimum size of this type known at compile-time.

const MIN_ALIGN: Alignment = const MIN_ALIGN: Alignment = Alignment::of::<T>();

Minimum alignment of this type known at compile-time.

fn size(_: *const T) -> usize

Get the size of an object of this type in bytes, with the metadata of the given pointer.

impl<T> PinInit<T> for T

unsafe fn __init(self, slot: *mut T) -> Result<(), !>

Initializes slot. Read more

fn pin_chain<F>(self, f: F) -> ChainPinInit<Self, F, T, E>
where F: FnOnce(Pin<&mut T>) -> Result<(), E>,

First initializes the value using self then calls the function f with the initialized value. Read more

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = !

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, !>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T, U, const N: u32> TryIntoBounded<T, N> for U
where T: Integer, U: TryInto<T>,

fn try_into_bounded(self) -> Option<Bounded<T, N>>

Attempts to convert self into a Bounded using N bits. Read more

impl<T> Writer for T
where T: Debug,

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

Formats the value using the given formatter.