Struct Ticks24

pub struct Ticks24(/* private fields */);

24-bit Ticks

Implementations

impl Ticks24

pub const MASK: u32 = 16_777_215u32

Trait Implementations

impl Clone for Ticks24

fn clone(&self) -> Ticks24

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Ticks24

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

Formats the value using the given formatter.

impl From<u32> for Ticks24

fn from(val: u32) -> Self

Converts to this type from the input type.

impl Ord for Ticks24

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 Ticks24

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

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 Ticks for Ticks24

fn max_value() -> Self

Returns the maximum value of this type, which should be (2^width)-1.

fn half_max_value() -> Self

Returns the half the maximum value of this type, which should be (2^width-1).

fn width() -> u32

Width of the actual underlying timer in bits.

fn into_usize(self) -> usize

Converts the type into a usize, stripping the higher bits it if it is larger than usize and filling the higher bits with 0 if it is smaller than usize.

fn into_u32(self) -> u32

Converts the type into a u32, stripping the higher bits it if it is larger than u32 and filling the higher bits with 0 if it is smaller than u32. Included as a simple helper since Tock uses u32 pervasively and most platforms are 32 bits.

fn wrapping_add(self, other: Self) -> Self

Add two values, wrapping around on overflow using standard unsigned arithmetic.

fn wrapping_sub(self, other: Self) -> Self

Subtract two values, wrapping around on underflow using standard unsigned arithmetic.

fn within_range(self, start: Self, end: Self) -> bool

Returns whether the value is in the range of [start, end) using unsigned arithmetic and considering wraparound. It returns trueif, incrementing fromstart, the value will be reached before end. Put another way, it returns (self - start) < (end - start)` in unsigned arithmetic.

fn from_or_max(val: u64) -> Self

Converts the specified val into this type if it fits otherwise the max_value() is returned

fn saturating_scale(self, numerator: u32, denominator: u32) -> u32

Scales the ticks by the specified numerator and denominator. If the resulting value would be greater than u32,u32::MAX is returned instead

fn usize_padding() -> u32

The amount of bits required to left-justify this ticks value range (filling the lower bits with 0) for it wrap at (2 ** usize::BITS) - 1 bits. For timers with a width larger than usize, this value will be 0 (i.e., they can simply be truncated to usize::BITS bits).

fn into_usize_left_justified(self) -> usize

Converts the type into a usize, left-justified and right-padded with 0 such that it is guaranteed to wrap at (2 ** usize::BITS) - 1. If it is larger than usize::BITS bits, any higher bits are stripped.

fn usize_left_justified_scale_freq<F: Frequency>() -> u32

Convert the generic Frequency argument into a frequency (Hertz) describing a left-justified ticks value as returned by Ticks::into_usize_left_justified.

fn u32_padding() -> u32

The amount of bits required to left-justify this ticks value range (filling the lower bits with 0) for it wrap at (2 ** 32) - 1 bits. For timers with a width larger than 32, this value will be 0 (i.e., they can simply be truncated to 32-bits).

fn into_u32_left_justified(self) -> u32

Converts the type into a u32, left-justified and right-padded with 0 such that it is guaranteed to wrap at (2 ** 32) - 1. If it is larger than 32-bits, any higher bits are stripped.

fn u32_left_justified_scale_freq<F: Frequency>() -> u32

Convert the generic Frequency argument into a frequency (Hertz) describing a left-justified ticks value as returned by Ticks::into_u32_left_justified.

impl Copy for Ticks24

impl Eq for Ticks24