Crate 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.

# fn main() {
use getargs::Options;
use getargs_os::OsArgument;

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

Then use 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:

# fn main() {
# use getargs::{Options, Arg};
# use getargs_os::{os, OsArgument};
# let mut opts = Options::new(argv::iter().skip(1).map(<&OsArgument>::from));
while let Some(arg) = opts.next_arg().expect("some ooga booga just happened") {
	if arg == Arg::Long(os!("help")) {
		// print help...
	} else {
		// ...
	}
}
# }

Macros

os

Creates an OS string from a literal string ("whatever").

osb

Creates an OsStr from a literal byte string (b"whatever").

Structs

OsArgument

A newtype wrapper around OsStr that allows it to be parsed by Options.

Enums

ShortOpt

Represents either a Unicode codepoint or an arbitrary byte. Used by OsArgument to represent short options.