From 2a0918d8bd2ed551e1cf3f503da659d3bddd2492 Mon Sep 17 00:00:00 2001 From: transistor Date: Sat, 24 Feb 2024 15:03:31 -0800 Subject: [PATCH] Moved femtos to its own repository --- .gitmodules | 3 + README.md | 5 + emulator/libraries/femtos | 1 + emulator/libraries/femtos/Cargo.toml | 14 - emulator/libraries/femtos/LICENSE-APACHE | 201 -------- emulator/libraries/femtos/LICENSE-MIT | 25 - emulator/libraries/femtos/README.md | 8 - emulator/libraries/femtos/src/lib.rs | 576 ----------------------- 8 files changed, 9 insertions(+), 824 deletions(-) create mode 100644 .gitmodules create mode 160000 emulator/libraries/femtos delete mode 100644 emulator/libraries/femtos/Cargo.toml delete mode 100644 emulator/libraries/femtos/LICENSE-APACHE delete mode 100644 emulator/libraries/femtos/LICENSE-MIT delete mode 100644 emulator/libraries/femtos/README.md delete mode 100644 emulator/libraries/femtos/src/lib.rs diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000..cb2b5ae --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "emulator/libraries/femtos"] + path = emulator/libraries/femtos + url = git@github.com:transistorfet/femtos.git diff --git a/README.md b/README.md index 82983a9..3e2bfbe 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,11 @@ of doc comments in the code yet but I plan to eventually write more: [rustdocs for moa_core](http://jabberwocky.ca/moa/doc/moa_core/) [rustdocs for ym2612](http://jabberwocky.ca/moa/doc/moa_peripherals_yamaha/ym2612/index.html) +This repository uses submodules, so make sure to clone with +```sh +git clone --recurse-submodules git@github.com:transistorfet/moa.git +``` + Sega Genesis/MegaDrive ---------------------- diff --git a/emulator/libraries/femtos b/emulator/libraries/femtos new file mode 160000 index 0000000..49ae560 --- /dev/null +++ b/emulator/libraries/femtos @@ -0,0 +1 @@ +Subproject commit 49ae560767057adb58113bfefafadda716262695 diff --git a/emulator/libraries/femtos/Cargo.toml b/emulator/libraries/femtos/Cargo.toml deleted file mode 100644 index ed22193..0000000 --- a/emulator/libraries/femtos/Cargo.toml +++ /dev/null @@ -1,14 +0,0 @@ -[package] -name = "femtos" -version = "0.1.0" -edition = "2021" -rust-version = "1.60" -categories = ["no-std", "emulation", "simulation"] -keywords = ["femtoseconds", "time", "emulation", "simulation"] -description = "a femtosecond-based representation of time, duration, and frequency, for the purpose of simulation" -authors = ["transistor fet "] -license = "MIT OR Apache-2.0" -repository = "https://github.com/transistorfet/moa" - -[dependencies] - diff --git a/emulator/libraries/femtos/LICENSE-APACHE b/emulator/libraries/femtos/LICENSE-APACHE deleted file mode 100644 index 16fe87b..0000000 --- a/emulator/libraries/femtos/LICENSE-APACHE +++ /dev/null @@ -1,201 +0,0 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - -TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - -1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - -2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - -3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - -4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - -5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - -6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - -7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - -8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - -9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - -END OF TERMS AND CONDITIONS - -APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - -Copyright [yyyy] [name of copyright owner] - -Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. diff --git a/emulator/libraries/femtos/LICENSE-MIT b/emulator/libraries/femtos/LICENSE-MIT deleted file mode 100644 index 2149c50..0000000 --- a/emulator/libraries/femtos/LICENSE-MIT +++ /dev/null @@ -1,25 +0,0 @@ -Copyright (c) 2024 transistor fet - -Permission is hereby granted, free of charge, to any -person obtaining a copy of this software and associated -documentation files (the "Software"), to deal in the -Software without restriction, including without -limitation the rights to use, copy, modify, merge, -publish, distribute, sublicense, and/or sell copies of -the Software, and to permit persons to whom the Software -is furnished to do so, subject to the following -conditions: - -The above copyright notice and this permission notice -shall be included in all copies or substantial portions -of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF -ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED -TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A -PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT -SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION -OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR -IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER -DEALINGS IN THE SOFTWARE. diff --git a/emulator/libraries/femtos/README.md b/emulator/libraries/femtos/README.md deleted file mode 100644 index 27fbbba..0000000 --- a/emulator/libraries/femtos/README.md +++ /dev/null @@ -1,8 +0,0 @@ -[![crates.io](https://img.shields.io/crates/v/femtos.svg)](https://crates.io/crates/femtos) -[![Documentation](https://docs.rs/femtos/badge.svg)](https://docs.rs/femtos) -![Minimum Supported Rust Version](https://img.shields.io/badge/rustc-1.60+-blue.svg) - -# `femtos` - -> A femtosecond representation of time, duration, and frequency - diff --git a/emulator/libraries/femtos/src/lib.rs b/emulator/libraries/femtos/src/lib.rs deleted file mode 100644 index 17fda66..0000000 --- a/emulator/libraries/femtos/src/lib.rs +++ /dev/null @@ -1,576 +0,0 @@ -#![doc = include_str!("../README.md")] -#![warn(missing_docs)] -#![no_std] - -use core::time; -use core::ops::{Add, AddAssign, Sub, SubAssign, Mul, MulAssign, Div, DivAssign}; - -/// Type to use for storing femtoseconds -/// -/// In webassembly, using u128 results in exceedingly slow runtimes, so we use u64 instead -/// which is enough for 5 hours of simulation time. -#[cfg(not(target_arch = "wasm32"))] -type Femtos = u128; -#[cfg(target_arch = "wasm32")] -type Femtos = u64; - -/// Represents a duration of time in femtoseconds -/// -/// The `Duration` type is used to represent lengths of time and is -/// intentionally similar to `std::time::Duration`, but which records -/// time as femtoseconds to keep accurancy when dealing with partial -/// nanosecond clock divisons. -#[derive(Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Ord)] -pub struct Duration { - femtos: Femtos, -} - -impl Duration { - /// A duration of zero (0) time - pub const ZERO: Self = Self::from_femtos(0); - - /// A duration of the maximum possible length in femtoseconds (`Femtos::MAX`) - /// - /// This will be equivalent to either u64::MAX or u128::MAX femtoseconds - pub const MAX: Self = Self::from_femtos(Femtos::MAX); - - /// The number of femtoseconds in 1 second as `Femtos` - pub const FEMTOS_PER_SEC: Femtos = 1_000_000_000_000_000; - - /// The number of femtoseconds in 1 millisecond as `Femtos` - pub const FEMTOS_PER_MILLISEC: Femtos = 1_000_000_000_000; - - /// The number of femtoseconds in 1 microsecond as `Femtos` - pub const FEMTOS_PER_MICROSEC: Femtos = 1_000_000_000; - - /// The number of femtoseconds in 1 nanosecond as `Femtos` - pub const FEMTOS_PER_NANOSEC: Femtos = 1_000_000; - - /// The number of femtoseconds in 1 picosecond as `Femtos` - pub const FEMTOS_PER_PICOSEC: Femtos = 1_000; - - /// Creates a new `Duration` from the specified number of seconds - /// - /// # Examples - /// - /// ``` - /// use femtos::Duration; - /// - /// let duration = Duration::from_secs(123); - /// - /// assert_eq!(123, duration.as_secs()); - /// ``` - #[inline] - pub const fn from_secs(secs: u64) -> Self { - Self { - femtos: secs as Femtos * Self::FEMTOS_PER_SEC, - } - } - - /// Creates a new `Duration` from the specified number of milliseconds - /// - /// # Examples - /// - /// ``` - /// use femtos::Duration; - /// - /// let duration = Duration::from_millis(123); - /// - /// assert_eq!(123, duration.as_millis()); - /// ``` - #[inline] - pub const fn from_millis(millisecs: u64) -> Self { - Self { - femtos: millisecs as Femtos * Self::FEMTOS_PER_MILLISEC, - } - } - - /// Creates a new `Duration` from the specified number of microseconds - /// - /// # Examples - /// - /// ``` - /// use femtos::Duration; - /// - /// let duration = Duration::from_micros(123); - /// - /// assert_eq!(123, duration.as_micros()); - /// ``` - #[inline] - pub const fn from_micros(microsecs: u64) -> Self { - Self { - femtos: microsecs as Femtos * Self::FEMTOS_PER_MICROSEC, - } - } - - /// Creates a new `Duration` from the specified number of nanoseconds - /// - /// # Examples - /// - /// ``` - /// use femtos::Duration; - /// - /// let duration = Duration::from_nanos(123); - /// - /// assert_eq!(123, duration.as_nanos()); - /// ``` - #[inline] - pub const fn from_nanos(nanosecs: u64) -> Self { - Self { - femtos: nanosecs as Femtos * Self::FEMTOS_PER_NANOSEC, - } - } - - /// Creates a new `Duration` from the specified number of picoseconds - /// - /// # Examples - /// - /// ``` - /// use femtos::Duration; - /// - /// let duration = Duration::from_picos(123); - /// - /// assert_eq!(123, duration.as_picos()); - /// ``` - #[inline] - pub const fn from_picos(picosecs: u128) -> Self { - Self { - femtos: picosecs as Femtos * Self::FEMTOS_PER_PICOSEC, - } - } - - /// Creates a new `Duration` from the specified number of femtoseconds - /// - /// # Examples - /// - /// ``` - /// use femtos::Duration; - /// - /// let duration = Duration::from_femtos(123); - /// - /// assert_eq!(123, duration.as_femtos()); - /// ``` - #[inline] - pub const fn from_femtos(femtos: Femtos) -> Self { - Self { - femtos, - } - } - - /// Returns the number of _whole_ seconds contained by this `Duration`. - /// - /// # Examples - /// - /// ``` - /// use femtos::Duration; - /// - /// let duration = Duration::from_femtos(123_465_789_012_345_678); - /// assert_eq!(duration.as_secs(), 123); - /// ``` - #[inline] - pub const fn as_secs(self) -> u64 { - (self.femtos / Self::FEMTOS_PER_SEC) as u64 - } - - /// Returns the number of _whole_ milliseconds contained by this `Duration`. - /// - /// # Examples - /// - /// ``` - /// use femtos::Duration; - /// - /// let duration = Duration::from_femtos(123_465_789_012_345_678); - /// assert_eq!(duration.as_millis(), 123_465); - /// ``` - #[inline] - pub const fn as_millis(self) -> u64 { - (self.femtos / Self::FEMTOS_PER_MILLISEC) as u64 - } - - /// Returns the number of _whole_ microseconds contained by this `Duration`. - /// - /// # Examples - /// - /// ``` - /// use femtos::Duration; - /// - /// let duration = Duration::from_femtos(123_465_789_012_345_678); - /// assert_eq!(duration.as_micros(), 123_465_789); - /// ``` - #[inline] - pub const fn as_micros(self) -> u64 { - (self.femtos / Self::FEMTOS_PER_MICROSEC) as u64 - } - - /// Returns the number of _whole_ nanoseconds contained by this `Duration`. - /// - /// # Examples - /// - /// ``` - /// use femtos::Duration; - /// - /// let duration = Duration::from_femtos(123_465_789_012_345_678); - /// assert_eq!(duration.as_nanos(), 123_465_789_012); - /// ``` - #[inline] - pub const fn as_nanos(self) -> u64 { - (self.femtos / Self::FEMTOS_PER_NANOSEC) as u64 - } - - /// Returns the number of _whole_ picoseconds contained by this `Duration`. - /// - /// # Examples - /// - /// ``` - /// use femtos::Duration; - /// - /// let duration = Duration::from_femtos(123_465_789_012_345_678); - /// assert_eq!(duration.as_picos(), 123_465_789_012_345); - /// ``` - #[inline] - #[allow(clippy::unnecessary_cast)] - pub const fn as_picos(self) -> u128 { - (self.femtos / Self::FEMTOS_PER_PICOSEC) as u128 - } - - /// Returns the number of _whole_ femtoseconds contained by this `Duration`. - /// - /// # Examples - /// - /// ``` - /// use femtos::Duration; - /// - /// let duration = Duration::from_femtos(123_465_789_012_345_678); - /// assert_eq!(duration.as_femtos(), 123_465_789_012_345_678); - /// ``` - #[inline] - pub const fn as_femtos(self) -> Femtos { - self.femtos - } - - /// Checked `Duration` addition. Computes `self + rhs`, returning [`None`] - /// if an overflow occured. - /// - /// # Examples - /// - /// ``` - /// use femtos::Duration; - /// - /// assert_eq!(Duration::from_secs(1).checked_add(Duration::from_secs(1)), Some(Duration::from_secs(2))) - /// assert_eq!(Duration::from_secs(1).checked_add(Duration::from_femtos(Femtos::MAX)), None) - /// ``` - #[inline] - pub const fn checked_add(self, rhs: Self) -> Option { - match self.femtos.checked_add(rhs.femtos) { - Some(femtos) => Some(Self::from_femtos(femtos)), - None => None, - } - } - - /// Checked `Duration` subtraction. Computes `self - rhs`, returning [`None`] - /// if an overflow occured. - /// - /// # Examples - /// - /// ``` - /// use femtos::Duration; - /// - /// assert_eq!(Duration::from_secs(1).checked_sub(Duration::from_secs(1)), Some(Duration::ZERO)) - /// assert_eq!(Duration::from_secs(1).checked_sub(Duration::from_femtos(2), None) - /// ``` - #[inline] - pub const fn checked_sub(self, rhs: Self) -> Option { - match self.femtos.checked_sub(rhs.femtos) { - Some(femtos) => Some(Self::from_femtos(femtos)), - None => None, - } - } -} - -impl Add for Duration { - type Output = Self; - - fn add(self, rhs: Self) -> Self::Output { - self.checked_add(rhs).expect("clock duration overflow during addition") - } -} - -impl AddAssign for Duration { - fn add_assign(&mut self, rhs: Self) { - *self = *self + rhs; - } -} - -impl Sub for Duration { - type Output = Self; - - fn sub(self, rhs: Self) -> Self::Output { - self.checked_sub(rhs).expect("clock duration overflow during subtraction") - } -} - -impl SubAssign for Duration { - fn sub_assign(&mut self, rhs: Self) { - *self = *self - rhs; - } -} - -impl Mul for Duration { - type Output = Self; - - fn mul(self, rhs: u64) -> Self::Output { - Self::from_femtos(self.femtos * rhs as Femtos) - } -} - -impl MulAssign for Duration { - fn mul_assign(&mut self, rhs: u64) { - *self = Self::from_femtos(self.femtos * rhs as Femtos); - } -} - -impl Div for Duration { - type Output = Self; - - fn div(self, rhs: u64) -> Self::Output { - Self::from_femtos(self.femtos / rhs as Femtos) - } -} - -impl DivAssign for Duration { - fn div_assign(&mut self, rhs: u64) { - *self = Self::from_femtos(self.femtos / rhs as Femtos); - } -} - -impl Div for Duration { - type Output = u64; - - fn div(self, rhs: Duration) -> Self::Output { - (self.femtos / rhs.femtos) as u64 - } -} - - -impl From for time::Duration { - fn from(value: Duration) -> Self { - time::Duration::from_nanos(value.as_nanos()) - } -} - -impl From for Duration { - fn from(value: time::Duration) -> Self { - Duration::from_nanos(value.as_nanos() as u64) - } -} - - -/// Represents time from the start of the simulation -/// -/// `Instant` is for representing the current running clock. It uses a -/// duration to represent the time from simulation start, and is monotonic. -#[derive(Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Ord)] -pub struct Instant(Duration); - -impl Instant { - /// An `Instant` representing the start of time (t = 0) - pub const START: Self = Self(Duration::ZERO); - /// An `Instant` representing the greatest possible time (t = `Femtos::MAX`) - pub const FOREVER: Self = Self(Duration::MAX); - - /// Returns a `Duration` equivalent to the amount of time elapsed since the earliest - /// possible time (t = 0). - #[inline] - pub const fn as_duration(self) -> Duration { - self.0 - } - - /// Returns the `Duration` that has elapsed between this `Instant` and `other`. - /// - /// # Examples - /// - /// ``` - /// use femtos::{Instant, Duration}; - /// - /// let now = Instant::START + Duration::from_secs(1); - /// assert_eq!(now.duration_since(Instant::START), Duration::from_secs(1)); - /// ``` - #[inline] - pub fn duration_since(self, other: Self) -> Duration { - self.0 - other.0 - } - - /// Checked `Instant` addition. Computes `self + duration`, returning [`None`] - /// if an overflow occured. - /// - /// # Examples - /// - /// ``` - /// use femtos::Instant; - /// - /// assert_eq!(Instant::START.checked_add(Duration::from_secs(1)).as_duration(), Some(Duration::from_secs(1))) - /// assert_eq!(Instant::START.checked_add(Duration::from_femtos(Femtos::MAX)).as_duration(), None) - /// ``` - #[inline] - pub const fn checked_add(self, duration: Duration) -> Option { - match self.0.checked_add(duration) { - Some(duration) => Some(Self(duration)), - None => None, - } - } - - /// Checked `Instant` subtraction. Computes `self - duration`, returning [`None`] - /// if an overflow occured. - /// - /// # Examples - /// - /// ``` - /// use femtos::Instant; - /// - /// assert_eq!(Instant::FOREVER.checked_sub(Duration::from_secs(1)).as_duration(), Some(Duration::from_femtos(Femtos::MAX - 1))) - /// assert_eq!(Instant::START.checked_sub(Duration::from_secs(1)).as_duration(), None) - /// ``` - #[inline] - pub const fn checked_sub(self, duration: Duration) -> Option { - match self.0.checked_sub(duration) { - Some(duration) => Some(Self(duration)), - None => None, - } - } -} - -impl Add for Instant { - type Output = Self; - - fn add(self, rhs: Duration) -> Self::Output { - Self(self.0.add(rhs)) - } -} - -impl AddAssign for Instant { - fn add_assign(&mut self, rhs: Duration) { - *self = Self(self.0.add(rhs)); - } -} - -/// Represents a frequency in Hz -/// -/// Clocks are usually given as a frequency, but durations are needed when dealing with clocks -/// and clock durations. This type makes it easier to create a clock of a given frequency and -/// convert it to a `Duration` -#[derive(Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Ord)] -pub struct Frequency { - hertz: u32, -} - -impl Frequency { - /// Creates a new `Frequency` from the specified number of hertz - /// - /// # Examples - /// - /// ``` - /// use femtos::Frequency; - /// - /// Frequency::from_hz(123); - /// ``` - #[inline] - pub const fn from_hz(hertz: u32) -> Self { - Self { - hertz, - } - } - - /// Creates a new `Frequency` from the specified number of kilohertz - /// - /// # Examples - /// - /// ``` - /// use femtos::Frequency; - /// - /// Frequency::from_khz(123); - /// ``` - #[inline] - pub const fn from_khz(khz: u32) -> Self { - Self { - hertz: khz * 1_000, - } - } - - /// Creates a new `Frequency` from the specified number of megahertz - /// - /// # Examples - /// - /// ``` - /// use femtos::Frequency; - /// - /// Frequency::from_mhz(123); - /// ``` - #[inline] - pub const fn from_mhz(mhz: u32) -> Self { - Self { - hertz: mhz * 1_000_000, - } - } - - /// Returns the frequency is hertz - #[inline] - pub const fn as_hz(self) -> u32 { - self.hertz - } - - /// Returns the frequency is kilohertz - #[inline] - pub const fn as_khz(self) -> u32 { - self.hertz / 1_000 - } - - /// Returns the frequency is megahertz - #[inline] - pub const fn as_mhz(self) -> u32 { - self.hertz / 1_000_000 - } - - /// Returns the `Duration` equivalent to the time period between cycles of - /// the given `Frequency` - /// - /// # Examples - /// - /// ``` - /// use femtos::Frequency; - /// - /// assert_eq!(Frequency::from_hz(1).period_duration(), Duration::from_secs(1)); - /// ``` - #[inline] - pub const fn period_duration(self) -> Duration { - Duration::from_femtos(Duration::FEMTOS_PER_SEC / self.hertz as Femtos) - } -} - -impl Mul for Frequency { - type Output = Self; - - fn mul(self, rhs: u32) -> Self::Output { - Self::from_hz(self.hertz * rhs) - } -} - -impl MulAssign for Frequency { - fn mul_assign(&mut self, rhs: u32) { - *self = Self::from_hz(self.hertz * rhs); - } -} - -impl Div for Frequency { - type Output = Self; - - fn div(self, rhs: u32) -> Self::Output { - Self::from_hz(self.hertz / rhs) - } -} - -impl DivAssign for Frequency { - fn div_assign(&mut self, rhs: u32) { - *self = Self::from_hz(self.hertz / rhs); - } -} -