Crate soph_console

Source

Modules§

builder
Define Command line arguments
colored
Module for drop-in colored support to aid in porting code from colored to owo-colors.
colors
Color types for used for being generic over the color
config
error
parser
Command line argument parser
styles
Different display styles (strikethrough, bold, etc.)
support
traits

Macros§

arg
Create an Arg from a usage string.
cfg_if
The main macro provided by this crate. See crate documentation for more information.
command
Requires cargo feature flag to be enabled.
value_parser
Select a ValueParser implementation from the intended type

Structs§

Arg
The abstract representation of a command line argument. Used to set all the options and relationships that define a valid argument for the program.
ArgGroup
Family of related arguments.
ArgMatches
Container for parse results.
BgColorDisplay
Transparent wrapper around a type which implements all the formatters the wrapped type does, with the addition of changing the background color. Recommended to be constructed using OwoColorize.
BgDynColorDisplay
Wrapper around a type which implements all the formatters the wrapped type does, with the addition of changing the background color. Is not recommended unless compile-time coloring is not an option.
ComboColorDisplay
A wrapper type which applies both a foreground and background color
ComboDynColorDisplay
Wrapper around a type which implements all the formatters the wrapped type does, with the addition of changing the foreground and background color.
Command
Build a command-line interface.
Console
FgColorDisplay
Transparent wrapper around a type which implements all the formatters the wrapped type does, with the addition of changing the foreground color. Recommended to be constructed using OwoColorize.
FgDynColorDisplay
Wrapper around a type which implements all the formatters the wrapped type does, with the addition of changing the foreground color. Is not recommended unless compile-time coloring is not an option.
Id
Arg or ArgGroup identifier
ParseColorError
An error for when the color can not be parsed from a string at runtime
Rgb
Available RGB colors for use with OwoColorize::color or OwoColorize::on_color
Style
A pre-computed style that can be applied to a struct using [OwoColorize::style].
StylePrefixFormatter
Formatter for the prefix of a Style.
StyleSuffixFormatter
Formatter for the suffix of a Style.
Styled
A wrapper type which applies a Style when displaying the inner type
StyledList
A collection of Styled items that are displayed in such a way as to minimize the amount of characters that are written when displayed.

Enums§

AnsiColors
Available standard ANSI colors for use with OwoColorize::color or OwoColorize::on_color
ArgAction
Behavior of arguments when they are encountered while parsing
ColorChoice
Represents the color preferences for program output
CssColors
Available CSS colors for use with OwoColorize::color or OwoColorize::on_color
DynColors
An enum describing runtime-configurable colors
Effect
A runtime-configurable text effect for use with Style
ValueHint
Provide shell with hint on how to complete an argument.
XtermColors
Available Xterm colors for use with OwoColorize::color or OwoColorize::on_color

Traits§

Args
Parse a set of arguments into a user-defined container.
Color
A trait for describing a type which can be used with FgColorDisplay or BgColorDisplay
CommandFactory
Create a Command relevant for a user-defined container.
DynColor
A trait describing a runtime-configurable color which can displayed using FgDynColorDisplay or BgDynColorDisplay. If your color will be known at compile time it is recommended you avoid this.
FromArgMatches
Converts an instance of ArgMatches to a user-defined container.
OwoColorize
Extension trait for colorizing a type which implements any std formatter (Display, Debug, UpperHex, etc.)
Parser
Parse command-line arguments into Self.
Subcommand
Parse a sub-command into a user-defined enum.
ValueEnum
Parse arguments into enums.

Functions§

style
Helper to create Styles more ergonomically

Type Aliases§

AnyError
BoxCallback
BoxClosure
BoxError
BoxFuture
Callback
Closure
Error
Command Line Argument Parser Error
Handler
Instance
Result
SharedString

Attribute Macros§

async_trait