Skip to main content

Module prelude

Module prelude 

Source
Expand description

Commonly used CLI primitive types from the focused crates.

Structs§

Arg
An owned command-line argument token.
BooleanFlag
A flag paired with a boolean state.
CliOption
A primitive command-line key/value option.
CliOptionName
A validated CLI option name without a leading --.
CommandName
A validated command name.
EnvVarName
An owned, validated environment variable name.
EnvVarValue
An owned environment variable value.
ExecutableName
A validated executable or binary name.
ExitCode
A portable process exit code primitive.
LongFlag
A long flag name such as verbose for --verbose.
OptionValue
An owned CLI option value.
PromptText
Owned prompt text.
RawArgs
A raw owned argument collection.
ShortFlag
A one-character short flag such as -v.
StderrDestination
Marker type for the process standard error stream.
StdinSource
Marker type for the process standard input stream.
StdoutDestination
Marker type for the process standard output stream.
TerminalHeight
A nonzero terminal height in rows.
TerminalSize
A terminal size value made from validated dimensions.
TerminalWidth
A nonzero terminal width in columns.

Enums§

ColorSupport
Primitive terminal color capability.
Flag
A primitive flag token.
Interactivity
Primitive stream interactivity state.
NewlineBehavior
Primitive newline policy for text output.
YesNoAnswer
A primitive yes/no answer.

Constants§

CONFIG_ERROR
Configuration error.
FAILURE
General failure.
SUCCESS
Successful completion.
USAGE_ERROR
Command line usage error.