module

Std.Args

21 public declarations

allOf&Std.Args.Args -> Str -> Array[Str]
Every value a repeated option was given, in the order they were written.
fn
Args
What a command line turned out to say.
type
ArgsError
Why a command line was refused.
type
Arity
How many values an option takes.
type
explain&Std.Args.ArgsError -> Str
Why a command line was refused, written for a person to read.
fn
flag&Std.Args.Spec -> Str -> Str -> Str -> Std.Args.Spec
An option that is either present or absent.
fn
fromCommandLine&Std.Args.Spec -> Result[Std.Args.Args, Std.Args.ArgsError]
Read the command line this program was given.
fn
isSet&Std.Args.Args -> Str -> Bool
Whether a flag was given.
fn
numberChecked&Std.Args.Args -> Str -> Result[Option[Int], Std.Args.ArgsError]
The value an option was given as a number, refusing text that is not one.
fn
numberOf&Std.Args.Args -> Str -> Option[Int]
The value an option was given, read as a whole number.
fn
Opt
One option a program accepts.
type
parse&Std.Args.Spec -> &Array[Str] -> Result[Std.Args.Args, Std.Args.ArgsError]
Read arguments against a spec, in one pass.
fn
repeated&Std.Args.Spec -> Str -> Str -> Str -> Std.Args.Spec
An option that may be given several times, keeping each value.
fn
required&Std.Args.Spec -> Str -> Str -> Str -> Std.Args.Spec
An option that takes a value and must be given.
fn
rest&Std.Args.Args -> Array[Str]
Everything that was not an option or an option's value.
fn
specStr -> Str -> Std.Args.Spec
A program that accepts nothing yet.
fn
Spec
What a program accepts, and the index that makes reading it one lookup.
type
usage&Std.Args.Spec -> Str
The usage text a program prints when asked, or when refusing.
fn
value&Std.Args.Spec -> Str -> Str -> Str -> Std.Args.Spec
An option that takes a value.
fn
valueOf&Std.Args.Args -> Str -> Option[Str]
The value an option was given.
fn
valueOr&Std.Args.Args -> Str -> Str -> Str
The value an option was given, or one to use when it was not.
fn