├── .github ├── CODE_OF_CONDUCT.md ├── CONTRIBUTING.md ├── ISSUE_TEMPLATE.md ├── PULL_REQUEST_TEMPLATE.md ├── stale.yml └── workflows │ └── ci.yml ├── .gitignore ├── .travis.yml ├── CERTIFICATE ├── CHANGELOG.md ├── Cargo.toml ├── LICENSE-APACHE ├── LICENSE-MIT ├── README.md ├── rustfmt.toml └── src └── lib.rs /.github/CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | In the interest of fostering an open and welcoming environment, we as 6 | contributors and maintainers pledge to making participation in our project and 7 | our community a harassment-free experience for everyone, regardless of age, body 8 | size, disability, ethnicity, gender identity and expression, level of 9 | experience, 10 | education, socio-economic status, nationality, personal appearance, race, 11 | religion, or sexual identity and orientation. 12 | 13 | ## Our Standards 14 | 15 | Examples of behavior that contributes to creating a positive environment 16 | include: 17 | 18 | - Using welcoming and inclusive language 19 | - Being respectful of differing viewpoints and experiences 20 | - Gracefully accepting constructive criticism 21 | - Focusing on what is best for the community 22 | - Showing empathy towards other community members 23 | 24 | Examples of unacceptable behavior by participants include: 25 | 26 | - The use of sexualized language or imagery and unwelcome sexual attention or 27 | advances 28 | - Trolling, insulting/derogatory comments, and personal or political attacks 29 | - Public or private harassment 30 | - Publishing others' private information, such as a physical or electronic 31 | address, without explicit permission 32 | - Other conduct which could reasonably be considered inappropriate in a 33 | professional setting 34 | 35 | 36 | ## Our Responsibilities 37 | 38 | Project maintainers are responsible for clarifying the standards of acceptable 39 | behavior and are expected to take appropriate and fair corrective action in 40 | response to any instances of unacceptable behavior. 41 | 42 | Project maintainers have the right and responsibility to remove, edit, or 43 | reject comments, commits, code, wiki edits, issues, and other contributions 44 | that are not aligned to this Code of Conduct, or to ban temporarily or 45 | permanently any contributor for other behaviors that they deem inappropriate, 46 | threatening, offensive, or harmful. 47 | 48 | ## Scope 49 | 50 | This Code of Conduct applies both within project spaces and in public spaces 51 | when an individual is representing the project or its community. Examples of 52 | representing a project or community include using an official project e-mail 53 | address, posting via an official social media account, or acting as an appointed 54 | representative at an online or offline event. Representation of a project may be 55 | further defined and clarified by project maintainers. 56 | 57 | ## Enforcement 58 | 59 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 60 | reported by contacting the project team at yoshuawuyts@gmail.com, or through 61 | IRC. All complaints will be reviewed and investigated and will result in a 62 | response that is deemed necessary and appropriate to the circumstances. The 63 | project team is obligated to maintain confidentiality with regard to the 64 | reporter of an incident. 65 | Further details of specific enforcement policies may be posted separately. 66 | 67 | Project maintainers who do not follow or enforce the Code of Conduct in good 68 | faith may face temporary or permanent repercussions as determined by other 69 | members of the project's leadership. 70 | 71 | ## Attribution 72 | 73 | This Code of Conduct is adapted from the Contributor Covenant, version 1.4, 74 | available at 75 | https://www.contributor-covenant.org/version/1/4/code-of-conduct.html 76 | -------------------------------------------------------------------------------- /.github/CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing 2 | Contributions include code, documentation, answering user questions, running the 3 | project's infrastructure, and advocating for all types of users. 4 | 5 | The project welcomes all contributions from anyone willing to work in good faith 6 | with other contributors and the community. No contribution is too small and all 7 | contributions are valued. 8 | 9 | This guide explains the process for contributing to the project's GitHub 10 | Repository. 11 | 12 | - [Code of Conduct](#code-of-conduct) 13 | - [Bad Actors](#bad-actors) 14 | - [Developer Certificate of Origin](#developer-certificate-of-origin) 15 | 16 | ## Code of Conduct 17 | The project has a [Code of Conduct][./CODE_OF_CONDUCT.md] that *all* 18 | contributors are expected to follow. This code describes the *minimum* behavior 19 | expectations for all contributors. 20 | 21 | As a contributor, how you choose to act and interact towards your 22 | fellow contributors, as well as to the community, will reflect back not only 23 | on yourself but on the project as a whole. The Code of Conduct is designed and 24 | intended, above all else, to help establish a culture within the project that 25 | allows anyone and everyone who wants to contribute to feel safe doing so. 26 | 27 | Should any individual act in any way that is considered in violation of the 28 | [Code of Conduct][./CODE_OF_CONDUCT.md], corrective actions will be taken. It is 29 | possible, however, for any individual to *act* in such a manner that is not in 30 | violation of the strict letter of the Code of Conduct guidelines while still 31 | going completely against the spirit of what that Code is intended to accomplish. 32 | 33 | Open, diverse, and inclusive communities live and die on the basis of trust. 34 | Contributors can disagree with one another so long as they trust that those 35 | disagreements are in good faith and everyone is working towards a common 36 | goal. 37 | 38 | ## Bad Actors 39 | All contributors to tacitly agree to abide by both the letter and 40 | spirit of the [Code of Conduct][./CODE_OF_CONDUCT.md]. Failure, or 41 | unwillingness, to do so will result in contributions being respectfully 42 | declined. 43 | 44 | A *bad actor* is someone who repeatedly violates the *spirit* of the Code of 45 | Conduct through consistent failure to self-regulate the way in which they 46 | interact with other contributors in the project. In doing so, bad actors 47 | alienate other contributors, discourage collaboration, and generally reflect 48 | poorly on the project as a whole. 49 | 50 | Being a bad actor may be intentional or unintentional. Typically, unintentional 51 | bad behavior can be easily corrected by being quick to apologize and correct 52 | course *even if you are not entirely convinced you need to*. Giving other 53 | contributors the benefit of the doubt and having a sincere willingness to admit 54 | that you *might* be wrong is critical for any successful open collaboration. 55 | 56 | Don't be a bad actor. 57 | 58 | ## Developer Certificate of Origin 59 | All contributors must read and agree to the [Developer Certificate of 60 | Origin (DCO)](../CERTIFICATE). 61 | 62 | The DCO allows us to accept contributions from people to the project, similarly 63 | to how a license allows us to distribute our code. 64 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | 7 | 8 | **Choose one:** is this a 🐛 bug report, a 🙋 feature request, or a 🔦 question? 9 | 10 | 11 | 12 | ## Expected Behavior 13 | 14 | 15 | 16 | 17 | ## Current Behavior 18 | 19 | 20 | 21 | 22 | ## Possible Solution 23 | 24 | 25 | 26 | ## Context 27 | 28 | 29 | 30 | ## Code Sample 31 | 32 | 33 | ## Your Environment 34 | 35 | 36 | | Software | Version(s) | 37 | | ---------------- | ---------- | 38 | | Package | 39 | | Runtime | 40 | | Package Manager | 41 | | Operating System | 42 | -------------------------------------------------------------------------------- /.github/PULL_REQUEST_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | 6 | 7 | **Choose one:** is this a 🐛 bug fix, a 🙋 feature, or a 🔦 documentation change? 8 | 9 | 10 | 11 | ## Checklist 12 | 13 | - [ ] tests pass 14 | - [ ] tests and/or benchmarks are included 15 | - [ ] documentation is changed or added 16 | 17 | ## Context 18 | 19 | 20 | ## Semver Changes 21 | 22 | -------------------------------------------------------------------------------- /.github/stale.yml: -------------------------------------------------------------------------------- 1 | # Configuration for probot-stale - https://github.com/probot/stale 2 | 3 | daysUntilStale: 90 4 | daysUntilClose: 7 5 | exemptLabels: 6 | - pinned 7 | - security 8 | exemptProjects: false 9 | exemptMilestones: false 10 | staleLabel: wontfix 11 | markComment: > 12 | This issue has been automatically marked as stale because it has not had 13 | recent activity. It will be closed if no further activity occurs. Thank you 14 | for your contributions. 15 | unmarkComment: false 16 | closeComment: false 17 | limitPerRun: 30 18 | -------------------------------------------------------------------------------- /.github/workflows/ci.yml: -------------------------------------------------------------------------------- 1 | name: 'CI' 2 | on: 3 | pull_request: 4 | push: 5 | branches: 6 | - master 7 | 8 | env: 9 | RUST_BACKTRACE: 1 10 | CARGO_TERM_COLOR: always 11 | 12 | jobs: 13 | ci-pass: 14 | name: CI is green 15 | runs-on: ubuntu-latest 16 | needs: 17 | - test-linux 18 | - test-windows 19 | - test-macos 20 | - build-extra 21 | - lint 22 | steps: 23 | - run: exit 0 24 | 25 | test-linux: 26 | runs-on: ubuntu-latest 27 | 28 | steps: 29 | - uses: actions/checkout@v3 30 | - uses: dtolnay/rust-toolchain@stable 31 | with: 32 | components: rustfmt 33 | - name: Run tests 34 | run: | 35 | cargo check 36 | cargo test 37 | 38 | test-windows: 39 | runs-on: windows-latest 40 | 41 | steps: 42 | - uses: actions/checkout@v3 43 | - uses: dtolnay/rust-toolchain@stable 44 | with: 45 | components: rustfmt 46 | - name: Run tests 47 | run: | 48 | cargo check 49 | cargo test 50 | 51 | test-macos: 52 | runs-on: macos-latest 53 | 54 | steps: 55 | - uses: actions/checkout@v3 56 | - uses: dtolnay/rust-toolchain@stable 57 | with: 58 | components: rustfmt 59 | - name: Run tests 60 | run: | 61 | cargo check 62 | cargo test 63 | 64 | build-extra: 65 | runs-on: ubuntu-latest 66 | 67 | steps: 68 | - uses: actions/checkout@v3 69 | - uses: dtolnay/rust-toolchain@stable 70 | with: 71 | targets: wasm32-unknown-unknown 72 | - name: Build WASM 73 | run: | 74 | cargo build --target=wasm32-unknown-unknown 75 | - name: Build benches 76 | run: | 77 | cargo build --benches 78 | - name: Build release 79 | run: | 80 | cargo build --release 81 | 82 | lint: 83 | runs-on: ubuntu-latest 84 | 85 | steps: 86 | - uses: actions/checkout@v3 87 | - uses: dtolnay/rust-toolchain@stable 88 | with: 89 | components: rustfmt, clippy 90 | - uses: actions-rs/clippy-check@v1 91 | with: 92 | token: ${{ secrets.GITHUB_TOKEN }} 93 | - name: Format check 94 | run: | 95 | cargo fmt -- --check 96 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules/ 2 | coverage/ 3 | tmp/ 4 | dist/ 5 | npm-debug.log* 6 | .DS_Store 7 | .nyc_output 8 | target/ 9 | Cargo.lock 10 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: rust 2 | rust: 3 | - stable 4 | 5 | before_script: | 6 | rustup component add rustfmt && 7 | rustup component add clippy 8 | script: | 9 | cargo fmt -- --check && 10 | cargo clippy -- -D clippy::all && 11 | cargo build --verbose && 12 | cargo test --verbose 13 | cache: cargo -------------------------------------------------------------------------------- /CERTIFICATE: -------------------------------------------------------------------------------- 1 | Developer Certificate of Origin 2 | Version 1.1 3 | 4 | Copyright (C) 2004, 2006 The Linux Foundation and its contributors. 5 | 1 Letterman Drive 6 | Suite D4700 7 | San Francisco, CA, 94129 8 | 9 | Everyone is permitted to copy and distribute verbatim copies of this 10 | license document, but changing it is not allowed. 11 | 12 | 13 | Developer's Certificate of Origin 1.1 14 | 15 | By making a contribution to this project, I certify that: 16 | 17 | (a) The contribution was created in whole or in part by me and I 18 | have the right to submit it under the open source license 19 | indicated in the file; or 20 | 21 | (b) The contribution is based upon previous work that, to the best 22 | of my knowledge, is covered under an appropriate open source 23 | license and I have the right under that license to submit that 24 | work with modifications, whether created in whole or in part 25 | by me, under the same open source license (unless I am 26 | permitted to submit under a different license), as indicated 27 | in the file; or 28 | 29 | (c) The contribution was provided directly to me by some other 30 | person who certified (a), (b) or (c) and I have not modified 31 | it. 32 | 33 | (d) I understand and agree that this project and the contribution 34 | are public and that a record of the contribution (including all 35 | personal information I submit with it, including my sign-off) is 36 | maintained indefinitely and may be redistributed consistent with 37 | this project or the open source license(s) involved. 38 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | ## 2023-04-12, Version 5.0.0 2 | ### Commits 3 | - [[`8a55cc70fd`](https://github.com/datrs/random-access-storage/commit/8a55cc70fd3195dbc8ca8495309ff918b9c39d1f)] Switch from Travis to GHA (Timo Tiuraniemi) 4 | - [[`3d2f8ebc6d`](https://github.com/datrs/random-access-storage/commit/3d2f8ebc6d05da5d98a21f25fec31d5799dfed97)] Document crate properly, opting for documentation in lib.rs instead of just README.md. (Timo Tiuraniemi) 5 | - [[`ec84e44776`](https://github.com/datrs/random-access-storage/commit/ec84e44776fcf2f51c3e2126ef4cb53786fa6972)] Bump edition to 2021 alongside the other breaking changes (Timo Tiuraniemi) 6 | - [[`682fbd32c3`](https://github.com/datrs/random-access-storage/commit/682fbd32c34fc75b44c835475ce6deeb7802d3c8)] Use a new major version for the interface (Timo Tiuraniemi) 7 | - [[`e8ffd39452`](https://github.com/datrs/random-access-storage/commit/e8ffd39452d320e4453cf94f82cb58cb0dd3ee5a)] Use a single OutOfBounds error for more convenient error matching (Timo Tiuraniemi) 8 | - [[`0119575c91`](https://github.com/datrs/random-access-storage/commit/0119575c91d42602fc3ea62279b4594e73ea98c6)] Switch from anyhow to thiserror and RandomAccessError (Timo Tiuraniemi) 9 | - [[`89f442ae20`](https://github.com/datrs/random-access-storage/commit/89f442ae2063b975e626eb88e154a1391dfb4ff6)] Remove read_to_writer and futures dep (Timo Tiuraniemi) 10 | - [[`ac9db1bf02`](https://github.com/datrs/random-access-storage/commit/ac9db1bf020cc727bdcb8a4ae0b6485803a65d66)] Fix missing &mut causing Sync compilation problems (Timo Tiuraniemi) 11 | - [[`a37f98c96d`](https://github.com/datrs/random-access-storage/commit/a37f98c96d59ed06d104f0db68c2144db9750006)] Update changelog (Bruno Tavares) 12 | 13 | ### Stats 14 | ```diff 15 | .github/workflows/ci.yml | 95 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 16 | CHANGELOG.md | 22 ++++++++++++++++++++++ 17 | Cargo.toml | 10 +++++----- 18 | README.md | 66 +++--------------------------------------------------------------- 19 | src/lib.rs | 188 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++--------------------------- 20 | 5 files changed, 286 insertions(+), 95 deletions(-) 21 | ``` 22 | 23 | 24 | ## 2020-03-03, Version 4.0.0 25 | ### Commits 26 | - [[`064eb1d6c9`](https://github.com/datrs/random-access-storage/commit/064eb1d6c9c1110f7cb01bfbaa6eb43d52330cd4)] (cargo-release) version 4.0.0 (Bruno Tavares) 27 | - [[`0e7ab518e5`](https://github.com/datrs/random-access-storage/commit/0e7ab518e5d529160073e5aa295ff6a711472944)] Merge pull request #22 from bltavares/async-trait (Bruno Tavares) 28 | - [[`2f5f4a0567`](https://github.com/datrs/random-access-storage/commit/2f5f4a0567db834f72afc6b75c512f309c9f4b13)] Github feedback: use futures-io to help with compile times (Bruno Tavares) 29 | - [[`2bf3131775`](https://github.com/datrs/random-access-storage/commit/2bf31317753b242bedec37a0a6a576f5c26533c7)] Implement async API for random-access-storage (Bruno Tavares) 30 | - [[`0bed19ef50`](https://github.com/datrs/random-access-storage/commit/0bed19ef50d0df238d0457e8af8890289ff385ed)] Merge pull request #20 from bltavares/master (Szabolcs Berecz) 31 | - [[`831b9aa23e`](https://github.com/datrs/random-access-storage/commit/831b9aa23e72fbe38cf19c3c7c794d8acfe9099a)] Adjust Travis to run clippy and rustfmt on stable only (Bruno Tavares) 32 | - [[`9c228739cc`](https://github.com/datrs/random-access-storage/commit/9c228739cc504d778b5c840d3d339dfbb54cae33)] Removes unused dependency (Bruno Tavares) 33 | - [[`e0a1ea9880`](https://github.com/datrs/random-access-storage/commit/e0a1ea9880a42f48459763d30724badcbe274ac2)] Update changelog (Yoshua Wuyts) 34 | 35 | ### Stats 36 | ```diff 37 | .travis.yml | 8 ++++---- 38 | CHANGELOG.md | 18 ++++++++++++++++++ 39 | Cargo.toml | 6 ++++-- 40 | README.md | 24 ++++++++++++------------ 41 | src/lib.rs | 29 ++++++++++++++++++----------- 42 | 5 files changed, 56 insertions(+), 29 deletions(-) 43 | ``` 44 | 45 | 46 | ## 2019-07-27, Version 3.0.0 47 | ### Commits 48 | - [[`49c25778a0`](https://github.com/datrs/random-access-storage/commit/49c25778a0f80db733028c059958303e374b5965)] (cargo-release) version 3.0.0 (Yoshua Wuyts) 49 | - [[`553af611fd`](https://github.com/datrs/random-access-storage/commit/553af611fde9a22e92b17c9b52cc1379cd4dc57d)] u64 file offsets (#17) (James Halliday) 50 | - [[`b73e7fb619`](https://github.com/datrs/random-access-storage/commit/b73e7fb619ebf07de6f5f409bee4f843cb0f0967)] sync_all method (#18) (James Halliday) 51 | - [[`02e700d41c`](https://github.com/datrs/random-access-storage/commit/02e700d41ce119325d09c762b697b957af16697a)] Changed signature of len() to immutably borrow self (#19) (Freddie Ridell) 52 | - [[`36c5b96d63`](https://github.com/datrs/random-access-storage/commit/36c5b96d63159317c6ec756ff579174e07856b10)] Update changelog (Yoshua Wuyts) 53 | 54 | ### Stats 55 | ```diff 56 | CHANGELOG.md | 16 ++++++++++++++++ 57 | Cargo.toml | 4 ++-- 58 | README.md | 4 ++++ 59 | src/lib.rs | 21 ++++++++++----------- 60 | 4 files changed, 32 insertions(+), 13 deletions(-) 61 | ``` 62 | 63 | 64 | ## 2018-12-18, Version 2.0.0 65 | ### Commits 66 | - [[`55ab88f0fd`](https://github.com/datrs/random-access-storage/commit/55ab88f0fd5114f8911442bc665fcca6949516ac)] (cargo-release) version 2.0.0 (Yoshua Wuyts) 67 | - [[`81319ec100`](https://github.com/datrs/random-access-storage/commit/81319ec100e196c0ad79528d966d7717005c38f1)] len() and is_empty() (#16) (James Halliday) 68 | - [[`fb18d9f5d3`](https://github.com/datrs/random-access-storage/commit/fb18d9f5d3a4b950f457d941acd69f6c57a11bf7)] Update changelog (Yoshua Wuyts) 69 | 70 | ### Stats 71 | ```diff 72 | CHANGELOG.md | 18 ++++++++++++++++++ 73 | Cargo.toml | 2 +- 74 | README.md | 8 ++++++++ 75 | src/lib.rs | 8 ++++++++ 76 | 4 files changed, 35 insertions(+), 1 deletion(-) 77 | ``` 78 | 79 | 80 | ## 2018-11-20, Version 1.0.0 81 | ### Commits 82 | - [[`2e9f4090d7`](https://github.com/datrs/random-access-storage/commit/2e9f4090d766a8fbaf6301e789b7db1439e383ad)] (cargo-release) version 1.0.0 (Yoshua Wuyts) 83 | - [[`5e423e35ff`](https://github.com/datrs/random-access-storage/commit/5e423e35ff60ad7ed918a883c776c287a4b9b3fe)] truncate method (#15) (James Halliday) 84 | - [[`0b242b6234`](https://github.com/datrs/random-access-storage/commit/0b242b6234586ceb1b23a2ac5a7ba5b021084be5)] Keep up with modern times in clippy invocation (#12) (Szabolcs Berecz) 85 | - [[`622cf79c92`](https://github.com/datrs/random-access-storage/commit/622cf79c92194ea234c92bd090cd061425331ff0)] update changelog (Yoshua Wuyts) 86 | 87 | ### Stats 88 | ```diff 89 | .travis.yml | 2 +- 90 | CHANGELOG.md | 19 +++++++++++++++++++ 91 | Cargo.toml | 2 +- 92 | README.md | 4 ++++ 93 | src/lib.rs | 4 ++++ 94 | 5 files changed, 29 insertions(+), 2 deletions(-) 95 | ``` 96 | 97 | 98 | ## 2018-08-29, Version 0.6.0 99 | ### Commits 100 | - [[`23e48f8e29`](https://github.com/datrs/random-access-storage/commits/23e48f8e29fc5cb0eaf7a0e77485cd6d23884771)] (cargo-release) version 0.6.0 (Yoshua Wuyts) 101 | - [[`f1fc4982aa`](https://github.com/datrs/random-access-storage/commits/f1fc4982aa1f1a4e6b919344810f87ec36be36c7)] Fixes #7: Make RandomAccess always open (#11) (Szabolcs Berecz) 102 | - [[`3855bef02a`](https://github.com/datrs/random-access-storage/commits/3855bef02a392bff362a297b610cdf9180f00ded)] Update README.md (#10) (周汉成) 103 | - [[`97ebff543c`](https://github.com/datrs/random-access-storage/commits/97ebff543c466582f68c7dd192361dc41a9646dc)] add read_to_writer method (#9) (Yoshua Wuyts) 104 | - [[`50b947e688`](https://github.com/datrs/random-access-storage/commits/50b947e688ef3ea5addd81991386ae389a66c1f6)] Fix typo and switch to clippy-preview (#5) (Szabolcs Berecz) 105 | - [[`61a3d42a56`](https://github.com/datrs/random-access-storage/commits/61a3d42a56cfba8c0803854394f9488e68525085)] (cargo-release) start next development iteration 0.5.1-alpha.0 (Yoshua Wuyts) 106 | 107 | ### Stats 108 | ```diff 109 | .travis.yml | 2 +- 110 | Cargo.toml | 2 +- 111 | README.md | 23 +++++++++++++++------- 112 | src/lib.rs | 66 ++++++++++---------------------------------------------------- 113 | 4 files changed, 29 insertions(+), 64 deletions(-) 114 | ``` 115 | 116 | 117 | -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "random-access-storage" 3 | version = "5.0.0" 4 | license = "MIT OR Apache-2.0" 5 | repository = "https://github.com/datrs/random-access-storage" 6 | documentation = "https://docs.rs/random-access-storage" 7 | description = "Abstract interface to implement random-access instances." 8 | authors = ["Yoshua Wuyts ", "Timo Tiuraniemi "] 9 | readme = "README.md" 10 | edition = "2021" 11 | 12 | [dependencies] 13 | async-trait = "0.1" 14 | thiserror = "1" 15 | -------------------------------------------------------------------------------- /LICENSE-APACHE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | Copyright 2018 Yoshua Wuyts 179 | 180 | Licensed under the Apache License, Version 2.0 (the "License"); 181 | you may not use this file except in compliance with the License. 182 | You may obtain a copy of the License at 183 | 184 | http://www.apache.org/licenses/LICENSE-2.0 185 | 186 | Unless required by applicable law or agreed to in writing, software 187 | distributed under the License is distributed on an "AS IS" BASIS, 188 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 189 | See the License for the specific language governing permissions and 190 | limitations under the License. 191 | -------------------------------------------------------------------------------- /LICENSE-MIT: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | 3 | Copyright (c) 2018 Yoshua Wuyts 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # random-access-storage 2 | [![crates.io version][1]][2] [![build status][3]][4] 3 | [![downloads][5]][6] [![docs.rs docs][7]][8] 4 | 5 | Abstract interface to implement random-access instances. 6 | 7 | - [Documentation][8] 8 | - [Crate][2] 9 | 10 | ## Installation 11 | ```sh 12 | $ cargo add random-access-storage 13 | ``` 14 | 15 | ## See Also 16 | - Original Javascript [random-access-storage](https://github.com/random-access-storage/random-access-storage) 17 | 18 | ## License 19 | [MIT](./LICENSE-MIT) OR [Apache-2.0](./LICENSE-APACHE) 20 | 21 | [1]: https://img.shields.io/crates/v/random-access-storage.svg?style=flat-square 22 | [2]: https://crates.io/crates/random-access-storage 23 | [3]: https://github.com/datrs/random-access-storage/actions/workflows/ci.yml/badge.svg 24 | [4]: https://github.com/datrs/random-access-storage/actions 25 | [5]: https://img.shields.io/crates/d/random-access-storage.svg?style=flat-square 26 | [6]: https://crates.io/crates/random-access-storage 27 | [7]: https://img.shields.io/badge/docs-latest-blue.svg?style=flat-square 28 | [8]: https://docs.rs/random-access-storage 29 | -------------------------------------------------------------------------------- /rustfmt.toml: -------------------------------------------------------------------------------- 1 | max_width = 80 2 | tab_spaces = 2 3 | -------------------------------------------------------------------------------- /src/lib.rs: -------------------------------------------------------------------------------- 1 | #![deny(missing_docs)] 2 | #![cfg_attr(test, deny(warnings))] 3 | #![doc(test(attr(deny(warnings))))] 4 | //! # Abstract interface to implement random-access instances 5 | //! 6 | //! This crate defines the shared [RandomAccess] trait that makes it possible to create 7 | //! different backends for reading, writing and deleting bytes. With a shared interface, 8 | //! implementations can easily be swapped, depending on the needs and the environment. 9 | //! 10 | //! ## Known Implementations 11 | //! 12 | //! Full implementations of [RandomAccess] include: 13 | //! 14 | //! * [random-access-memory](https://docs.rs/random-access-memory) for in-memory storage 15 | //! * [random-access-disk](https://docs.rs/random-access-disk) for disk storage 16 | //! 17 | //! ## Examples 18 | //! 19 | //! Your own random-access backend can be implemented like this: 20 | //! 21 | //! ``` 22 | //! use random_access_storage::{RandomAccess, RandomAccessError}; 23 | //! use async_trait::async_trait; 24 | //! 25 | //! struct MyRandomAccess { 26 | //! // Add fields here 27 | //! } 28 | //! 29 | //! #[async_trait] 30 | //! impl RandomAccess for MyRandomAccess { 31 | //! async fn write(&mut self, _offset: u64, _data: &[u8]) -> Result<(), RandomAccessError> { 32 | //! unimplemented!(); 33 | //! } 34 | // 35 | //! async fn read(&mut self, _offset: u64, _length: u64) -> Result, RandomAccessError> { 36 | //! unimplemented!(); 37 | //! } 38 | //! 39 | //! async fn del(&mut self, _offset: u64, _length: u64) -> Result<(), RandomAccessError> { 40 | //! unimplemented!(); 41 | //! } 42 | //! 43 | //! async fn truncate(&mut self, _length: u64) -> Result<(), RandomAccessError> { 44 | //! unimplemented!(); 45 | //! } 46 | //! 47 | //! async fn len(&mut self) -> Result { 48 | //! unimplemented!(); 49 | //! } 50 | //! 51 | //! async fn is_empty(&mut self) -> Result { 52 | //! unimplemented!(); 53 | //! } 54 | //! 55 | //! async fn sync_all(&mut self) -> Result<(), RandomAccessError> { 56 | //! unimplemented!(); 57 | //! } 58 | //! } 59 | //! ``` 60 | use thiserror::Error; 61 | 62 | /// Error type for the [RandomAccess] trait methods. 63 | #[derive(Error, Debug)] 64 | pub enum RandomAccessError { 65 | /// Given parameters are out of bounds. 66 | #[error("{} out of bounds. {} < {}{}", 67 | .end.as_ref().map_or_else(|| "Offset", |_| "Range"), 68 | .length, 69 | .offset, 70 | .end.as_ref().map_or_else(String::new, |end| format!("..{}", end)))] 71 | OutOfBounds { 72 | /// Offset that was out of bounds 73 | offset: u64, 74 | /// If it was a range that was out of bounds, the end of the range. 75 | end: Option, 76 | /// The length in the implementation that was exceeded. 77 | length: u64, 78 | }, 79 | /// Unexpected [std::io::Error]. 80 | #[error("Unrecoverable input/output error occured.{}{}", 81 | .return_code.as_ref().map_or_else(String::new, |rc| format!(" Return code: {}.", rc)), 82 | .context.as_ref().map_or_else(String::new, |ctx| format!(" Context: {}.", ctx)))] 83 | IO { 84 | /// Optional system return code that caused the error. 85 | return_code: Option, 86 | /// Optional context of the error. 87 | context: Option, 88 | /// Source of the error. 89 | #[source] 90 | source: std::io::Error, 91 | }, 92 | } 93 | 94 | impl From for RandomAccessError { 95 | fn from(err: std::io::Error) -> Self { 96 | Self::IO { 97 | return_code: None, 98 | context: None, 99 | source: err, 100 | } 101 | } 102 | } 103 | 104 | /// Interface for reading from, writing to and deleting from a 105 | /// randomly accessible storage of bytes. 106 | #[async_trait::async_trait] 107 | pub trait RandomAccess { 108 | /// Write bytes of `data` at an `offset` to the backend. 109 | /// 110 | /// # Errors 111 | /// 112 | /// * [RandomAccessError::OutOfBounds] if the backend has 113 | /// a maximum capacity that would be exceeded by the write. 114 | /// 115 | /// * [RandomAccessError::IO] if an unexpected IO error occurred. 116 | async fn write( 117 | &mut self, 118 | offset: u64, 119 | data: &[u8], 120 | ) -> Result<(), RandomAccessError>; 121 | 122 | /// Read a sequence of bytes at an `offset` from the backend. 123 | /// 124 | /// # Errors 125 | /// 126 | /// * [RandomAccessError::OutOfBounds] if 127 | /// [RandomAccess::len] > `offset` + `length`. 128 | /// 129 | /// * [RandomAccessError::IO] if an unexpected IO error occurred. 130 | async fn read( 131 | &mut self, 132 | offset: u64, 133 | length: u64, 134 | ) -> Result, RandomAccessError>; 135 | 136 | /// Delete a sequence of bytes of given `length` at an `offset` from the backend. 137 | /// This either sets the bytes in the given slice to zeroes, or if 138 | /// `offset` + `length` >= [RandomAccess::len()] is the same as 139 | /// `truncate(offset)`. 140 | /// 141 | /// # Errors 142 | /// 143 | /// * [RandomAccessError::OutOfBounds] if [RandomAccess::len()] < `offset` + `length`. 144 | /// 145 | /// * [RandomAccessError::IO] if an unexpected IO error occurred. 146 | async fn del( 147 | &mut self, 148 | offset: u64, 149 | length: u64, 150 | ) -> Result<(), RandomAccessError>; 151 | 152 | /// Resize the sequence of bytes so that [RandomAccess::len()] is set to 153 | /// `length`. If `length` < [RandomAccess::len()], the bytes are disregarded. 154 | /// If `length` > [RandomAccess::len()], the storage is zero-padded. 155 | /// 156 | /// # Errors 157 | /// 158 | /// * [RandomAccessError::OutOfBounds] if the backend has 159 | /// a maximum capacity smaller than `length`. 160 | /// 161 | /// * [RandomAccessError::IO] if an unexpected IO error occurred. 162 | async fn truncate(&mut self, length: u64) -> Result<(), RandomAccessError>; 163 | 164 | /// Get the size of the storage in bytes. 165 | /// 166 | /// # Errors 167 | /// 168 | /// * [RandomAccessError::IO] if an unexpected IO error occurred. 169 | async fn len(&mut self) -> Result; 170 | 171 | /// Whether the storage is empty. For some storage backends it may be 172 | /// cheaper to calculate whether the storage is empty than to calculate the 173 | /// length. 174 | /// 175 | /// # Errors 176 | /// 177 | /// * [RandomAccessError::IO] if an unexpected IO error occurred. 178 | async fn is_empty(&mut self) -> Result; 179 | 180 | /// Flush buffered data on the underlying storage resource. 181 | /// 182 | /// # Errors 183 | /// 184 | /// * [RandomAccessError::IO] if an unexpected IO error occurred. 185 | async fn sync_all(&mut self) -> Result<(), RandomAccessError>; 186 | } 187 | --------------------------------------------------------------------------------