getargs-os

Crates.iogetargs-os
lib.rsgetargs-os
version0.1.1
sourcesrc
created_at2022-12-12 10:00:40.54589
updated_at2023-06-27 23:01:56.706423
descriptionProvides a way for `getargs` to parse OS strings
homepagehttps://github.com/LoganDark/getargs-os
repositoryhttps://github.com/LoganDark/getargs-os
max_upload_size
id734908
size17,485
LoganDark (LoganDark)

documentation

https://docs.rs/getargs-os

README

getargs-os

Adds a newtype wrapper (OsArgument) around OsStr that allows it to be parsed by getargs::Options.

In combination with the argv crate, this allows for lowest-cost argument parsing across all platforms (zero-cost on Linux).

This is a separate crate from getargs because it requires (wildly) unsafe code. std does not want us messing with OsStrs at all!

Usage

First, obtain an iterator over OsStrs somehow - I recommend argv once again - then wrap them in OsArgument and pass that to Options::new.

use getargs::Options;
use getargs_os::OsArgument;
let mut opts = Options::new(argv::iter().skip(1).map(<&OsArgument>::from));

Then use Optionsgetargs::Options as normal - check its documentation for more usage examples.

You can use the os! macro to create new OS strings to compare arguments against. This macro works on all operating systems. For example:

while let Some(arg) = opts.next_arg().expect("some ooga booga just happened") {
	if arg == Arg::Long(os!("help")) {
		// print help...
	} else {
		// ...
	}
}
Commit count: 7

cargo fmt