Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jwodder/patharg

Treat "-" (hyphen/dash) arguments as stdin/stdout
https://github.com/jwodder/patharg

args argv available-on-crates-io rust stdin stdout

Last synced: 20 days ago
JSON representation

Treat "-" (hyphen/dash) arguments as stdin/stdout

Host: GitHub
URL: https://github.com/jwodder/patharg
Owner: jwodder
License: mit
Created: 2023-04-18T23:23:20.000Z (over 1 year ago)
Default Branch: master
Last Pushed: 2024-02-10T18:11:18.000Z (9 months ago)
Last Synced: 2024-04-10T22:56:02.379Z (7 months ago)
Topics: args, argv, available-on-crates-io, rust, stdin, stdout
Language: Rust
Homepage:
Size: 68.4 KB
Stars: 2
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

        [![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)

[![CI Status](https://github.com/jwodder/patharg/actions/workflows/test.yml/badge.svg)](https://github.com/jwodder/patharg/actions/workflows/test.yml)

[![codecov.io](https://codecov.io/gh/jwodder/patharg/branch/master/graph/badge.svg)](https://codecov.io/gh/jwodder/patharg)

[![Minimum Supported Rust Version](https://img.shields.io/badge/MSRV-1.74-orange)](https://www.rust-lang.org)

[![MIT License](https://img.shields.io/github/license/jwodder/patharg.svg)](https://opensource.org/licenses/MIT)

[GitHub](https://github.com/jwodder/patharg) | [crates.io](https://crates.io/crates/patharg) | [Documentation](https://docs.rs/patharg) | [Issues](https://github.com/jwodder/patharg/issues) | [Changelog](https://github.com/jwodder/patharg/blob/master/CHANGELOG.md)

Most CLI commands that take file paths as arguments follow the convention of

treating a path of `-` (a single hyphen/dash) as referring to either standard

input or standard output (depending on whether the path is read from or written

to).  The `patharg` crate lets your programs follow this convention too: it

provides `InputArg` and `OutputArg` types that wrap command-line arguments,

with methods for reading from/writing to either the given path or — if the

argument is just a hyphen — the appropriate standard stream.

`InputArg` and `OutputArg` implement `From`, `From`, and

`FromStr`, so you can use them seamlessly with your favorite Rust source of

command-line arguments, be it [`clap`][], [`lexopt`][], plain old

[`std::env::args`][args]/[`std::env::args_os`][args_os], or whatever else is

out there.  The source repository contains examples of two of these:

- [`examples/flipcase.rs`][flipcase] and

  [`examples/tokio-flipcase.rs`][tokio-flipcase] show how to use this crate

  with `clap`.

- [`examples/revchars.rs`][revchars] and

  [`examples/tokio-revchars.rs`][tokio-revchars] show how to use this crate

  with `lexopt`.

[`clap`]: https://crates.io/crates/clap

[`lexopt`]: https://crates.io/crates/lexopt

[args]: https://doc.rust-lang.org/std/env/fn.args.html

[args_os]: https://doc.rust-lang.org/std/env/fn.args_os.html

[flipcase]: https://github.com/jwodder/patharg/blob/master/examples/flipcase.rs

[tokio-flipcase]: https://github.com/jwodder/patharg/blob/master/examples/tokio-flipcase.rs

[revchars]: https://github.com/jwodder/patharg/blob/master/examples/revchars.rs

[tokio-revchars]: https://github.com/jwodder/patharg/blob/master/examples/tokio-revchars.rs

Comparison with clio

====================

The only other library I am aware of that provides similar functionality to

`patharg` is [`clio`][].  Compared to `clio`, `patharg` aims to be a much

simpler, smaller library that doesn't try to be too clever.  Major differences

between the libraries include:

- When a `clio` path instance is created, `clio` will either (depending on the

  type used) open the path immediately — which can lead to empty files being

  needlessly left behind if an output file is constructed during argument

  processing but an error occurs before the file is actually used — or else

  check that the path can be opened — which is vulnerable to TOCTTOU bugs.

  `patharg` does no such thing.

- `clio` supports reading from & writing to HTTP(S) URLs and has special

  treatment for FIFOs.  `patharg` sees no need for such excesses.

- `patharg` has a feature for allowing async I/O with [`tokio`][].  `clio` does

  not.

- `patharg` has optional support for [`serde`][].  `clio` does not.

[`clio`]: https://crates.io/crates/clio

[`tokio`]: https://crates.io/crates/tokio

[`serde`]: https://crates.io/crates/serde