mirror of https://github.com/chipsenkbeil/distant
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
50 lines
1.6 KiB
Markdown
50 lines
1.6 KiB
Markdown
# distant net
|
|
|
|
[![Crates.io][distant_crates_img]][distant_crates_lnk] [![Docs.rs][distant_doc_img]][distant_doc_lnk] [![Rustc 1.61.0][distant_rustc_img]][distant_rustc_lnk]
|
|
|
|
[distant_crates_img]: https://img.shields.io/crates/v/distant-net.svg
|
|
[distant_crates_lnk]: https://crates.io/crates/distant-net
|
|
[distant_doc_img]: https://docs.rs/distant-net/badge.svg
|
|
[distant_doc_lnk]: https://docs.rs/distant-net
|
|
[distant_rustc_img]: https://img.shields.io/badge/distant_net-rustc_1.61+-lightgray.svg
|
|
[distant_rustc_lnk]: https://blog.rust-lang.org/2022/05/19/Rust-1.61.0.html
|
|
|
|
Library that powers the [`distant`](https://github.com/chipsenkbeil/distant)
|
|
binary.
|
|
|
|
🚧 **(Alpha stage software) This library is in rapid development and may break or change frequently!** 🚧
|
|
|
|
## Details
|
|
|
|
The `distant-net` library supplies the foundational networking functionality
|
|
for the distant interfaces and distant cli.
|
|
|
|
## Installation
|
|
|
|
You can import the dependency by adding the following to your `Cargo.toml`:
|
|
|
|
```toml
|
|
[dependencies]
|
|
distant-net = "0.18"
|
|
```
|
|
|
|
## Features
|
|
|
|
Currently, the library supports the following features:
|
|
|
|
- `schemars`: derives the `schemars::JsonSchema` interface on `Request`
|
|
and `Response` data types
|
|
|
|
By default, no features are enabled on the library.
|
|
|
|
## License
|
|
|
|
This project is licensed under either of
|
|
|
|
Apache License, Version 2.0, (LICENSE-APACHE or
|
|
[apache-license][apache-license]) MIT license (LICENSE-MIT or
|
|
[mit-license][mit-license]) at your option.
|
|
|
|
[apache-license]: http://www.apache.org/licenses/LICENSE-2.0
|
|
[mit-license]: http://opensource.org/licenses/MIT
|