diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index f98c455..5314d66 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -85,6 +85,62 @@ jobs: command: test args: --workspace --all-targets --all-features --release + no_std: + needs: build-and-test + runs-on: ubuntu-latest + strategy: + matrix: + rust: [nightly, beta, stable] + crates: [ + "stable-sorted", + ] + + steps: + - uses: actions/checkout@v2 + + - name: Install ${{ matrix.rust }} + uses: actions-rs/toolchain@v1 + with: + toolchain: ${{ matrix.rust }} + target: riscv64gc-unknown-none-elf + override: true + + - name: Cache cargo state + uses: actions/cache@v2 + env: + cache-name: cache-cargo + with: + path: | + ~/.cargo/registry + ~/.cargo/git + ~/.cargo/bin + key: ubuntu-latest-${{ matrix.rust }}-${{ env.cache-name }}-${{ hashFiles('**/Cargo.toml') }}-build + restore-keys: | + ubuntu-latest-${{ matrix.rust }}-${{ env.cache-name }}-${{ hashFiles('**/Cargo.toml') }}- + ubuntu-latest-${{ matrix.rust }}-${{ env.cache-name }}- + ubuntu-latest-${{ matrix.rust }}- + ubuntu-latest- + + - name: Cache target dir + uses: actions/cache@v2 + env: + cache-name: cache-target + with: + path: | + target/ + key: ubuntu-latest-${{ matrix.rust }}-${{ env.cache-name }}-${{ hashFiles('**/Cargo.toml') }}-build + restore-keys: | + ubuntu-latest-${{ matrix.rust }}-${{ env.cache-name }}-${{ hashFiles('**/Cargo.toml') }}- + ubuntu-latest-${{ matrix.rust }}-${{ env.cache-name }}- + ubuntu-latest-${{ matrix.rust }}- + ubuntu-latest- + + - name: Check + uses: actions-rs/cargo@v1 + with: + command: check + args: --release --target=riscv64gc-unknown-none-elf --manifest-path ${{ matrix.crates }}/Cargo.toml + format: runs-on: ubuntu-latest steps: diff --git a/Cargo.toml b/Cargo.toml index 2b87012..7ac593c 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -3,6 +3,7 @@ members = [ "packable/packable", "packable/packable-derive", "packable/packable-derive-test", + "stable-sorted", ] # The resolver is a global setting for a workspace, and the setting is ignored diff --git a/stable-sorted/CHANGELOG.md b/stable-sorted/CHANGELOG.md new file mode 100644 index 0000000..a011ae1 --- /dev/null +++ b/stable-sorted/CHANGELOG.md @@ -0,0 +1,26 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + + + +## 0.1.0 - 2022-01-17 + +### Added + +- Initial features; diff --git a/stable-sorted/Cargo.toml b/stable-sorted/Cargo.toml new file mode 100644 index 0000000..5f75226 --- /dev/null +++ b/stable-sorted/Cargo.toml @@ -0,0 +1,11 @@ +[package] +name = "stable-sorted" +version = "0.1.0" +authors = [ "IOTA Stiftung" ] +edition = "2021" +description = "Stable functions for checking iterator sorting." +readme = "README.md" +repository = "https://github.com/iotaledger/common-rs" +license = "Apache-2.0" +keywords = [ "iota", "iterator", "sorted", "stable" ] +homepage = "https://www.iota.org" diff --git a/stable-sorted/LICENSE b/stable-sorted/LICENSE new file mode 100644 index 0000000..f433b1a --- /dev/null +++ b/stable-sorted/LICENSE @@ -0,0 +1,177 @@ + + 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 diff --git a/stable-sorted/README.md b/stable-sorted/README.md new file mode 100644 index 0000000..44afb5a --- /dev/null +++ b/stable-sorted/README.md @@ -0,0 +1,3 @@ +# stable-sorted + +Provides `stable` functions for checking that an `Iterator` is sorted. diff --git a/stable-sorted/src/lib.rs b/stable-sorted/src/lib.rs new file mode 100644 index 0000000..64a2360 --- /dev/null +++ b/stable-sorted/src/lib.rs @@ -0,0 +1,43 @@ +// Copyright 2021-2022 IOTA Stiftung +// SPDX-License-Identifier: Apache-2.0 + +//! Provides `stable` functions for checking that an `Iterator` is sorted. + +#![no_std] +#![deny(missing_docs)] + +use core::{cmp::Ordering, iter::Iterator}; + +/// Checks if an iterator yields ordered and unique values. +pub fn is_unique_sorted>(mut iterator: I) -> bool { + let mut previous = match iterator.next() { + Some(e) => e, + None => return true, + }; + + for curr in iterator { + if previous.cmp(&curr) != Ordering::Less { + return false; + } + previous = curr; + } + + true +} + +/// Checks if an iterator yields ordered values. +pub fn is_sorted>(mut iterator: I) -> bool { + let mut previous = match iterator.next() { + Some(e) => e, + None => return true, + }; + + for curr in iterator { + if previous.cmp(&curr) == Ordering::Greater { + return false; + } + previous = curr; + } + + true +} diff --git a/stable-sorted/tests/ord.rs b/stable-sorted/tests/ord.rs new file mode 100644 index 0000000..6fd2c08 --- /dev/null +++ b/stable-sorted/tests/ord.rs @@ -0,0 +1,50 @@ +// Copyright 2021-2022 IOTA Stiftung +// SPDX-License-Identifier: Apache-2.0 + +extern crate alloc; + +use alloc::vec::Vec; + +#[test] +fn empty_is_sorted() { + let vec = Vec::::new(); + assert!(stable_sorted::is_sorted(vec.iter())); +} + +#[test] +fn is_sorted() { + let vec = Vec::from([0, 1, 2, 3, 5, 7, 10, 12, 29]); + assert!(stable_sorted::is_sorted(vec.iter())); +} + +#[test] +fn not_sorted() { + let vec = Vec::from([0, 1, 2, 3, 5, 7, 10, 29, 12]); + assert!(!stable_sorted::is_sorted(vec.iter())); +} + +#[test] +fn empty_is_unique_sorted() { + let vec = Vec::::new(); + assert!(stable_sorted::is_unique_sorted(vec.iter())); +} + +#[test] +fn is_unique_sorted() { + let vec = Vec::from([0, 1, 2, 3, 5, 7, 10, 12, 29]); + assert!(stable_sorted::is_unique_sorted(vec.iter())); +} + +#[test] +fn sorted_not_unique() { + let vec = Vec::from([0, 1, 2, 3, 5, 7, 10, 12, 12]); + assert!(stable_sorted::is_sorted(vec.iter())); + assert!(!stable_sorted::is_unique_sorted(vec.iter())); +} + +#[test] +fn not_sorted_not_unique() { + let vec = Vec::from([0, 1, 2, 3, 5, 7, 12, 10, 12]); + assert!(!stable_sorted::is_sorted(vec.iter())); + assert!(!stable_sorted::is_unique_sorted(vec.iter())); +}