Trait Cycled

pub trait Cycled<T> {
    // Required methods
    fn cycle_period(&self) -> T;
    fn cycle_normalize(&self, value: T) -> T;
    fn cycle_count(&self) -> T;
    fn cycle_offset(&self) -> T;
    fn with_offset(&self, offset: T) -> Self;
    fn cycles_in_range(&self, range: T) -> T;
}

Cyclic behavior.

Defines operations common to periodic structures, such as retrieving the period, normalizing values within the cycle, applying offsets, and handling bounded or repeated cycles.

Required Methods

fn cycle_period(&self) -> T

Returns the fundamental period of the cycle.

fn cycle_normalize(&self, value: T) -> T

Normalizes a value within the cycle’s periodic range.

Ensures that the input value is wrapped within [0, period).

fn cycle_count(&self) -> T

fn cycle_offset(&self) -> T

fn with_offset(&self, offset: T) -> Self

Advances the cycle by a given offset.

This may modify internal state or return a new cycle with the offset applied.

fn cycles_in_range(&self, range: T) -> T

Determines how many complete cycles fit within a given range.

This method is useful for bounded or counted cycles.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors