Skip to content

CHANGELOG.md

Latest commit

 

History

History
261 lines (161 loc) · 7.57 KB

CHANGELOG.md

File metadata and controls

261 lines (161 loc) · 7.57 KB

Changelog

Unreleased

0.12.1 - 2021-10-02

Fixed

  • Instant comparison returned wrong result if equal

0.12.0 - 2021-05-30

Fixed

  • make Generic::integer() return a value

Changed

  • limit Rate and Duration extension to u32
  • removed all use os unwrap()

0.11.0 - 2021-05-06

Fixed

  • generic duration comparisons

Added

  • serde support
  • symmetric Duration/Instant math

Changed

  • export TimeInt trait
  • FixedPoint::integer() returns by value

0.10.1 - 2020-11-15

Changed

  • add Div bound to fix nightly build

0.10.0 - 2020-08-28

Added

  • multiplication and division (both operator and checked) of durations and rates by integers

Changed

  • eliminate auto-widening in rate and duration conversions

Removed

  • conversions between binary-rate (kibi, mebi) and decimal-rate (kilo, mega) types

Documentation

  • clarify and add documentation concerning Generic types
  • update intra-kind (duration/rate) conversion examples

0.9.1 - 2020-08-07

Changed

  • Re-export Fraction type in the duration and rate module
    • Allows for a single import (eg use duration::*) to support Generic usage which uses Fraction
  • Unify readme's and crate-level documentation
    • The GitHub README.md and crates.io crates-io.md are now generated using cargo-readme

0.9.0 - 2020-08-05

Added

  • From implementations for infallible intra-rate and intra-duration conversions
  • Implementations of common traits to types
  • More frequency types: mebihertz (MiHz) and kibihertz(KiHz)
  • More test coverage

Changed

  • Fallible intra-rate and intra-duration conversions use try_from()/try_into() rather than the try_convert_ methods
  • Replaced try_into_generic() with to_generic()
  • Replaced try_from_(duration/rate) with to_duration() and to_rate()
  • Return Options from checked_ methods rather than Results
  • Remove impl-specific Clock error type (ImplError)

Removed

  • trait module
    • duration- and/or rate-specific functionality can be imported separately by using duration::* and rate::*

0.8.1 - 2020-07-25

Fixed

The way the conversions from duration to rate (Rate::try_from_duration()) and from rate to duration (Duration::try_from_rate()) were causing unnecessary arithmetic overflows and type conversion failures. These functions are now optimized similar to the other similar conversion algorithms.

0.8.0 - 2020-07-24

Added

  • A full range of rate types implemented at the same level as the duration types (as a fixed-point value)

    Units Extension
    Megahertz MHz
    Kilohertz kHz
    Hertz Hz
    MebibytePerSecond MiBps
    MegabytePerSecond MBps
    KibibytePerSecond KiBps
    KiloBytePerSecond KBps
    BytePerSecond Bps
    MebibitPerSecond Mibps
    MegabitPerSecond Mbps
    KibibitPerSecond Kibps
    KilobitPerSecond kbps
    BitPerSecond bps
    Mebibaud MiBd
    Megabaud MBd
    Kibibaud KiBd
    Kilobaud kBd
    Baud Bd

  • Conversion between duration and rate types

    Microseconds::<u32>::try_from_rate(Kilohertz(2_u32)) -> Ok(Microseconds(500_u32))
Kilohertz::<u32>::try_from_duration(Microseconds(2_u32)) -> Ok(Kilohertz(500_u32))

  • Generic duration/rate types returned by Instant methods that return a duration/rate and convertible to/from named durations/rates

    Seconds(2_u64).try_into_generic(Fraction::new(1, 2_000)) -> Ok(Generic::new(4_000_u32, Fraction::new(1, 2_000))))
Seconds::<u64>::try_from(Generic::new(2_000_u32, Fraction::new(1, 1_000))) -> Ok(Seconds(2_u64))

Hertz(2_u64).try_into_generic(Fraction::new(1,2_000)) -> Ok(Generic::new(4_000_u32, Fraction::new(1,2_000))))
Hertz::<u64>::try_from(Generic::new(2_000_u32, Fraction::new(1,1_000))) -> Ok(Hertz(2_u64))

Changed

  • Rename frequency module to rate
  • Updated crate description
  • The const PERIODs in duration and clock traits is now const SCALING_FACTOR
  • The Period type is renamed to Fraction and is no longer generic (now u32)

0.7.0 - 2020-07-13

Added

  • Error propagation for all fallible paths including conversion errors as well as Clock implementation-specific errors
  • Construct-and-read benchmark comparison to core::time::duration showing embedded-time to be approximately 2.5 times faster

Fixed

  • Intermittent Timer test failures
  • Derive Copy for Hertz

0.6.0 - 2020-07-03

Added

  • A Timer type supporting one-shot and periodic software timers utilizing a Clock implementation
  • Fallibility and error handling for Clock methods
  • Instant::duration_until() with order checking
  • Order checking to Instant::duration_since()
  • Bounds checking on Instant impls of Add/Sub
  • Changelog back to v0.5.0 release
  • crossbeam-utils dev-dependency for scoped threads in tests

Changed

  • Add &self to Clock functions (make stateful, or at least allow stateful implementations)
  • All time-type inner types from signed to unsigned
  • Instant::duration_since() return type to Result
  • Refactor examples/nrf52_dk

0.5.2 - 2020-06-21

Added

Changed

  • Moved majority of Duration-related documentation to Duration trait
  • Minor refactoring

0.5.1 - 2020-06-21

Changed

  • Repository location

Removed

  • Period from prelude mod as it is no longer a trait

0.5.0 - 2020-06-17

Added

  • cargo doc CI test
  • Frequency-based type (Hertz) with conversion to/from Period
  • CI tests for stable

Changed

  • Rename duration::time_units to duration::units (units is also re-exported)
  • Rename TimeRep to TimeInt
  • Update num to v0.3.x
  • Make Period a struct that wraps a Ratio, rather than a trait

Removed

  • associated_type_bounds feature flag to allow stable build
  • Re-export of the duration module (wasn't useful)