Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/clap-rs/clap-port-flag
Easily add address & port flags to CLIs using Clap
https://github.com/clap-rs/clap-port-flag
clap cli rust
Last synced: 9 days ago
JSON representation
Easily add address & port flags to CLIs using Clap
- Host: GitHub
- URL: https://github.com/clap-rs/clap-port-flag
- Owner: clap-rs
- License: apache-2.0
- Created: 2018-06-03T13:13:03.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-12-18T18:00:01.000Z (11 months ago)
- Last Synced: 2024-05-28T16:28:52.182Z (6 months ago)
- Topics: clap, cli, rust
- Language: Rust
- Homepage:
- Size: 71.3 KB
- Stars: 15
- Watchers: 9
- Forks: 2
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE-APACHE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# clap-port-flag
[![crates.io version][1]][2] [![build status][3]][4]
[![downloads][5]][6] [![docs.rs docs][7]][8]
Easily add a `--port` flag to CLIs using clap.
- [Documentation][8]
- [Crates.io][2]
## Usage
### Example: Base
With the following code in `src/main.rs`:
```rust,no_run
use clap::Parser;
use clap_port_flag::Port;
#[derive(Debug, Parser)]
struct Cli {
#[clap(flatten)]
port: Port,
}
fn main() {
let args = Cli::parse();
let _tcp_listener = args.port.bind().unwrap();
}
```
When you run the binary, it'll provide the following output:
```txt
my-cool-app 0.2.0
Alice Person
Application that does things over TCP.
USAGE:
main [OPTIONS]
FLAGS:
-h, --help Prints help information
-V, --version Prints version information
OPTIONS:
--listen-fd A previously opened network socket. [env: LISTEN_FD=]
-a, --address The network address to listen to. [default: 127.0.0.1]
-p, --port The network port to listen to. [env: PORT=]
```
### Example: Hyper
```rust,no_run
use clap_port_flag::Port;
use futures::prelude::*;
use hyper::service::service_fn;
use hyper::{Body, Response, Request};
use clap::Parser;
#[derive(Debug, Parser)]
struct Cli {
#[clap(flatten)]
port: Port,
}
async fn hello(_: Request) -> Result, std::convert::Infallible> {
Ok(Response::new(String::from("Hello World!")))
}
#[tokio::main]
async fn main() -> Result<(), Box> {
let args = Cli::parse();
let listener = args.port.bind()?;
let listener = tokio::net::TcpListener::from_std(listener)?;
let addr = listener.local_addr()?;
println!("Server listening on {}", addr);
let (stream, _) = listener.accept().await?;
if let Err(e) = hyper::server::conn::Http::new()
.serve_connection(stream, service_fn(hello))
.await
{
eprintln!("server error: {}", e);
}
Ok(())
}
```
## Installation
```sh
$ cargo add clap-port-flag
```
## Further Reading
- [WhatWG URL spec](https://url.spec.whatwg.org/)
- [nodejs.org/api/url](https://nodejs.org/api/url.html)
## Acknowledgements
The original version of this crate was sketched out by
[@TeXitoi](https://github.com/TeXitoi) in
[rust-lang-nursery/cli-wg#37](https://github.com/rust-lang-nursery/cli-wg/issues/37).
## License
[MIT](./LICENSE-MIT) OR [Apache-2.0](./LICENSE-APACHE)
[1]: https://img.shields.io/crates/v/clap-port-flag.svg?style=flat-square
[2]: https://crates.io/crates/clap-port-flag
[3]: https://img.shields.io/travis/rust-clique/clap-port-flag.svg?style=flat-square
[4]: https://travis-ci.org/rust-clique/clap-port-flag
[5]: https://img.shields.io/crates/d/clap-port-flag.svg?style=flat-square
[6]: https://crates.io/crates/clap-port-flag
[7]: https://docs.rs/clap-port-flag/badge.svg
[8]: https://docs.rs/clap-port-flag