Struct Delay

pub struct Delay { /* private fields */ }

The delay of a frame relative to the previous one.

The ratio is reduced on construction which means equality comparisons is reliable even when mixing different bases. Note however that there is an upper limit to the delays that can be represented exactly when using Self::from_saturating_duration which depends on the granularity of the interval.

use image::Delay;
let delay_10ms = Delay::from_numer_denom_ms(10, 1);
let delay_10000us = Delay::from_numer_denom_ms(10_000, 1_000);

assert_eq!(delay_10ms, delay_10000us);

Implementations

impl Delay

pub fn from_numer_denom_ms(numerator: u32, denominator: u32) -> Delay

Create a delay from a ratio of milliseconds.

Examples

use image::Delay;
let delay_10ms = Delay::from_numer_denom_ms(10, 1);

pub fn from_saturating_duration(duration: Duration) -> Delay

Convert from a duration, clamped between 0 and an implemented defined maximum.

The maximum is at least i32::MAX milliseconds. It should be noted that the accuracy of the result may be relative and very large delays have a coarse resolution.

Examples

use std::time::Duration;
use image::Delay;

let duration = Duration::from_millis(20);
let delay = Delay::from_saturating_duration(duration);

pub fn numer_denom_ms(self) -> (u32, u32)

The numerator and denominator of the delay in milliseconds.

This is guaranteed to be an exact conversion if the Delay was previously created with the from_numer_denom_ms constructor.

Trait Implementations

impl Clone for Delay

fn clone(&self) -> Delay

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Delay

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

Formats the value using the given formatter.

impl From<Delay> for Duration

fn from(delay: Delay) -> Duration

Converts to this type from the input type.

impl PartialEq for Delay

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

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

impl Eq for Delay

impl StructuralPartialEq for Delay