Struct PulseTicks 

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

Number of ticks, restricting the range to 0 to 32,767.

Implementations

impl PulseTicks

pub const fn zero() -> Self

Use zero ticks.

pub const fn max() -> Self

Use the maximum value of 32767.

pub const fn new(ticks: u16) -> Result<Self, EspError>

Create a PulseTicks from the given number of ticks.

Errors

If the given number of ticks is larger than PulseTicks::max(), an error with the code ESP_ERR_INVALID_ARG will be returned.

pub const fn new_with_duration( resolution: Hertz, duration: Duration, ) -> Result<Self, EspError>

Constructs a PulseTicks from a [Duration].

Errors

If the duration is too long to be represented as ticks with the given resolution, an error with the code [ERR_EOVERFLOW] or ESP_ERR_INVALID_ARG will be returned.

pub const fn ticks(&self) -> u16

Returns the number of ticks.

pub const fn duration(&self, resolution: Hertz) -> Duration

Returns the duration it takes for the number of ticks, depending on the given clock ticks.

Panics

This function panics if the conversion from ticks to duration overflows.

Trait Implementations

impl Clone for PulseTicks

fn clone(&self) -> PulseTicks

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PulseTicks

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

Formats the value using the given formatter.

impl Default for PulseTicks

fn default() -> PulseTicks

Returns the “default value” for a type.

impl Ord for PulseTicks

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

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

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

impl Eq for PulseTicks

impl StructuralPartialEq for PulseTicks