rivia-vfs

Crates.iorivia-vfs
lib.rsrivia-vfs
version0.2.5
sourcesrc
created_at2021-11-20 14:31:29.599878
updated_at2022-04-04 14:26:28.732538
descriptionErgonomic facade for the Rivia Virtual FileSystem
homepage
repositoryhttps://github.com/phR0ze/rivia-vfs
max_upload_size
id484923
size105,710
(phR0ze)

documentation

README

rivia-vfs

license-badge build codecov crates.io Minimum rustc

Ergonomic facade for the Rivia Virtual FileSystem

Quick links

Usage

Rustc requirements

This minimum rustc requirement is driven by the enhancements made to Rust's std::error::Error handling improvements

Contribute

Pull requests are always welcome. However understand that they will be evaluated purely on whether or not the change fits with my goals/ideals for the project.

Project guidelines:

  • Chaining - ensure Rust's functional chaining style isn't impeded by additions
  • Brevity - keep the naming as concise as possible while not infringing on clarity
  • Clarity - keep the naming as unambiguous as possible while not infringing on brevity
  • Performance - keep convenience functions as performant as possible while calling out significant costs
  • Speed - provide ergonomic functions similar to rapid development languages
  • Comfort - use naming and concepts in similar ways to popular languages

Dev Environment

Automatic version

Enable the git hooks to have the version automatically incremented on commits

cd ~/Projects/rivia-vfs
git config core.hooksPath .githooks

Testing

Test in container

TBD

License

This project is licensed under either of:

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this project by you, shall be dual licensed as above, without any additional terms or conditions.


Backlog

Changelog

Commit count: 15

cargo fmt