No description
Find a file
Paul Campbell a0262a4d05
All checks were successful
Rust / build (map[name:stable]) (push) Successful in 1m22s
Rust / build (map[name:nightly]) (push) Successful in 3m50s
Release Please / Release-plz (push) Successful in 32s
feat(fs): kxio::fs::new(...) now accepts impl Into<PathBuf>
2024-11-09 19:35:03 +00:00
.cargo build: switch to forgejo actions 2024-10-29 22:30:17 +00:00
.forgejo/workflows build: switch to forgejo actions 2024-10-29 22:30:17 +00:00
.git-hooks feat: initial empty library 2024-04-08 14:33:39 +01:00
examples feat(fs): kxio::fs::new(...) now accepts impl Into<PathBuf> 2024-11-09 19:35:03 +00:00
src feat(fs): kxio::fs::new(...) now accepts impl Into<PathBuf> 2024-11-09 19:35:03 +00:00
tests feat: Net and MockNet wrappers for InnerNet<Mocker> and InnerNet<Unmocked> 2024-11-09 15:42:53 +00:00
.git-next.toml build: Add .git-next.toml config file 2024-04-16 07:06:50 +01:00
.gitignore build: ignore cargo-mutants output 2024-11-08 18:12:25 +00:00
.rgignore feat: initial empty library 2024-04-08 14:33:39 +01:00
bacon.toml feat: initial empty library 2024-04-08 14:33:39 +01:00
Cargo.toml docs(example): get and save 2024-11-09 15:42:53 +00:00
justfile build: add cargo mutants to local dev test build step 2024-11-09 17:30:18 +00:00
LICENSE feat: initial empty library 2024-04-08 14:33:39 +01:00
README.md docs(readme): write a proper readme 2024-11-09 18:27:39 +00:00
renovate.json chore(deps): prevent renovate creating pointless PRs 2024-04-27 14:29:48 +01:00

kxio

kxio is a Rust library that provides injectable FileSystem and Network resources to enhance the testability of your code. By abstracting system-level interactions, kxio enables easier mocking and testing of code that relies on file system and network operations.

Features

  • Filesystem Abstraction
  • Network Abstraction
  • Enhanced Testability

Filesystem

The Filesystem module offers a clean abstraction over std::fs, the standard file system operations. For comprehensive documentation and usage examples, please refer to the https://docs.rs/kxio/latest/kxio/fs/.

Key Filesystem Features:

  • File reading and writing
  • Directory operations
  • File metadata access
  • Fluent API for operations like .reader().bytes()

Network

The Network module offers a testable interface over the reqwest crate. For comprehensive documentation and usage examples, please refer to https://docs.rs/kxio/latest/kxio/net/

Getting Started

Add kxio to your Cargo.toml:

[dependencies]
kxio = "x.y.z"

Usage

See the example get.rs for an annotated example on how to use the kxio library. It covers both the net and fs modules.

Development

Contributing

Contributions are welcome! Please check our issue tracker for open tasks or submit your own ideas.

License

This project is licensed under the terms specified in the LICENSE file in the repository root.

Acknowledgements

  • Built with Rust

For more information, bug reports, or feature requests, please visit our repository.