Struct RefreshRate 

pub struct RefreshRate { /* private fields */ }

A display refresh rate expressed as an exact rational number (numerator/denominator in Hz).

Integer rates (60 Hz, 120 Hz, etc.) use denom = 1. NTSC-derived fractional rates use denom = 1001 (e.g. 60000/1001 ≈ 59.94 Hz, 24000/1001 ≈ 23.976 Hz).

Always stored in lowest terms: all constructors (including Deserialize) apply GCD reduction, so ==, Hash, and Ord are consistent and a given rate has exactly one canonical representation.

Use RefreshRate::integral for integer rates and RefreshRate::fractional for all others. From<u32> and From<u16> are implemented as integral conversions, so integer literals work wherever impl Into<RefreshRate> is accepted.

Implementations

impl RefreshRate

pub fn integral(hz: u32) -> Self

Constructs an integer refresh rate (e.g. RefreshRate::integral(60) → 60/1).

pub fn fractional(numer: u32, denom: u32) -> Self

Constructs an exact rational refresh rate, reduced to lowest terms.

Panics

Panics if denom is zero.

pub fn from_ratio(numer: u64, denom: u64) -> Option<Self>

Constructs a refresh rate from a numer/denom ratio in Hz, reduced to lowest terms.

Useful when the rate is computed from intermediate values that exceed u32, such as pixel_clock_hz / (h_total × v_total) for detailed-timing descriptors. Reduces in u64 then narrows to u32.

Returns None if denom is zero or if the reduced fraction does not fit in u32.

use display_types::RefreshRate;

// NTSC-style fractional rate computed from a large numerator and denominator.
let r = RefreshRate::from_ratio(60_000_000, 1_001_000).unwrap();
assert_eq!(r, RefreshRate::fractional(60_000, 1_001));

pub fn numer(self) -> u32

Numerator of the reduced fraction, in Hz.

pub fn denom(self) -> u32

Denominator of the reduced fraction (1 for integer rates, 1001 for NTSC-derived rates).

pub fn as_f64(self) -> f64

Returns the refresh rate as f64.

Trait Implementations

impl Clone for RefreshRate

fn clone(&self) -> RefreshRate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RefreshRate

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

Formats the value using the given formatter.

impl Display for RefreshRate

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

Formats the value using the given formatter.

impl From<u16> for RefreshRate

fn from(hz: u16) -> Self

Converts to this type from the input type.

impl From<u32> for RefreshRate

fn from(hz: u32) -> Self

Converts to this type from the input type.

impl Hash for RefreshRate

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 RefreshRate

fn cmp(&self, other: &Self) -> 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 RefreshRate

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

fn partial_cmp(&self, other: &Self) -> 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 Copy for RefreshRate

impl Eq for RefreshRate

impl StructuralPartialEq for RefreshRate