Zafu/Cli/Args/Types

`Zafu/Cli/Args/Types`

private package

source code:

src/Zafu/Cli/Args/Types.bosatsu

public dependencies: Zafu/Collection/HashMap, Zafu/Collection/HashSet, Zafu/Collection/NonEmptyChain, Zafu/Collection/NonEmptyList, Zafu/Control/Result, Zafu/Text/Pretty

Index

Types: ArgInfo, Args, Cardinality, CliError, Command, CommandSelection, DecodeResult, HelpConfig, IndexedToken, MatchState, NamedOccurrence, ParseConfig, ParseResult, PositionalOccurrence, PrimitiveKind, PrimitiveSpec, Scope, Spelling, Subcommand, ValueForm, ValueKind, ValueParser

Types

`ArgInfo`

type ArgInfo

Constructors

ArgInfo( help: Option[Zafu/Text/Pretty::Doc], metavar_override: Option[Zafu/Text/Pretty::Doc], group_id: Option[String], hidden: Bool, default_doc: Option[Zafu/Text/Pretty::Doc], examples: List[Zafu/Text/Pretty::Doc] )

`Args[a]`

type Args[a: +*]

Constructors

Map[b](source: Args[b], fn: b -> a)
Map2[b, c](left: Args[b], right: Args[c], fn: (b, c) -> a)
OrElse(left: Args[a], right: Args[a])
Primitive(spec: PrimitiveSpec[a], info: ArgInfo)
Pure(value: a)
Subcommands(commands: Zafu/Collection/NonEmptyList::NonEmptyList[Subcommand[Args, a]], info: ArgInfo)
Validate[b]( source: Args[b], fn: b -> Zafu/Control/Result::Result[Zafu/Text/Pretty::Doc, a], label: Zafu/Text/Pretty::Doc )
WithGroupDocs(source: Args[a], group_docs: Zafu/Collection/HashMap::HashMap[String, Zafu/Text/Pretty::Doc])
WithInfo(source: Args[a], fn: ArgInfo -> ArgInfo)
WithScope(source: Args[a], scope: Scope)

`Cardinality`

type Cardinality

Constructors

CountOccurrences
ExactlyOne
OneOrMore
ZeroOrMore
ZeroOrOne

`CliError`

type CliError

Constructors

AmbiguousSpecification(command_path: List[String], detail: Zafu/Text/Pretty::Doc)
DuplicateOccurrence(command_path: List[String], target: Zafu/Text/Pretty::Doc)
MissingArgument(command_path: List[String], target: Zafu/Text/Pretty::Doc)
MissingValue(command_path: List[String], target: Zafu/Text/Pretty::Doc)
UnexpectedArgument(command_path: List[String], token: String)
UnknownCommand(command_path: List[String], token: String)
UnknownOption(command_path: List[String], token: String)
ValidationError(command_path: List[String], detail: Zafu/Text/Pretty::Doc)
ValueParseError( command_path: List[String], target: Zafu/Text/Pretty::Doc, raw_value: String, detail: Zafu/Text/Pretty::Doc )

`Command[a]`

type Command[a: +*]

Constructors

Command( name: String, summary: Option[Zafu/Text/Pretty::Doc], description: Option[Zafu/Text/Pretty::Doc], footer: Option[Zafu/Text/Pretty::Doc], aliases: List[String], examples: List[Zafu/Text/Pretty::Doc], help_enabled: Bool, version_doc: Option[Zafu/Text/Pretty::Doc], args: Args[a] )

`CommandSelection`

type CommandSelection

Constructors

CommandSelection(token_index: Int, depth: Int, raw_name: String, canonical_name: String)

`DecodeResult[a]`

type DecodeResult[a: +*]

Constructors

DecodeResult(claimed: Zafu/Collection/HashSet::HashSet[Int], value: a)

`HelpConfig`

type HelpConfig

Constructors

HelpConfig(width: Int, show_hidden: Bool, show_defaults: Bool, show_examples: Bool)

`IndexedToken`

type IndexedToken

Constructors

IndexedToken(index: Int, raw: String)

`MatchState`

type MatchState

Constructors

MatchState( tokens: List[IndexedToken], named_occurrences: List[NamedOccurrence], positional_occurrences: List[PositionalOccurrence], command_steps: List[CommandSelection], command_path: List[String], auto_claimed: Zafu/Collection/HashSet::HashSet[Int] )

`NamedOccurrence`

type NamedOccurrence

Constructors

NamedOccurrence( segment_depth: Int, spelling: Spelling, token_index: Int, value_index: Option[Int], value_text: Option[String], raw_token: String )

`ParseConfig`

type ParseConfig

Constructors

ParseConfig( help_spellings: Zafu/Collection/NonEmptyList::NonEmptyList[Spelling], version_spellings: Zafu/Collection/NonEmptyList::NonEmptyList[Spelling], short_clusters: Bool, stop_at_double_dash: Bool, case_sensitive: Bool )

`ParseResult[a]`

type ParseResult[a: +*]

Constructors

Failed(errors: Zafu/Collection/NonEmptyChain::NonEmptyChain[CliError], doc: Zafu/Text/Pretty::Doc)
Parsed(value: a)
RequestedHelp(command_path: List[String], doc: Zafu/Text/Pretty::Doc)
RequestedVersion(doc: Zafu/Text/Pretty::Doc)

`PositionalOccurrence`

type PositionalOccurrence

Constructors

PositionalOccurrence(segment_depth: Int, token_index: Int, raw_value: String)

`PrimitiveKind`

type PrimitiveKind

Constructors

FlagValue(spellings: Zafu/Collection/NonEmptyList::NonEmptyList[Spelling], rendered: Zafu/Text/Pretty::Doc)
NamedOptionalValue(spellings: Zafu/Collection/NonEmptyList::NonEmptyList[Spelling], metavar: Zafu/Text/Pretty::Doc)
NamedValue(spellings: Zafu/Collection/NonEmptyList::NonEmptyList[Spelling], metavar: Zafu/Text/Pretty::Doc)
Positional(metavar: Zafu/Text/Pretty::Doc)
Rest(metavar: Zafu/Text/Pretty::Doc)

`PrimitiveSpec[a]`

type PrimitiveSpec[a: +*]

Constructors

PrimitiveSpec( kind: PrimitiveKind, cardinality: Cardinality, scope: Scope, decode_fn: (MatchState, Int, Scope, ArgInfo) -> Zafu/Control/Result::Result[Zafu/Collection/NonEmptyChain::NonEmptyChain[CliError], DecodeResult[a]] )

`Scope`

type Scope

Constructors

Inherited
Local

`Spelling`

type Spelling

Constructors

Spelling( prefix: String, name: String, value_kind: ValueKind, value_forms: List[ValueForm], clusterable: Bool )

`Subcommand[f, a]`

type Subcommand[f: +(+* -> *), a: +*]

Constructors

Subcommand( name: String, aliases: List[String], summary: Option[Zafu/Text/Pretty::Doc], description: Option[Zafu/Text/Pretty::Doc], footer: Option[Zafu/Text/Pretty::Doc], examples: List[Zafu/Text/Pretty::Doc], help_enabled: Bool, version_doc: Option[Zafu/Text/Pretty::Doc], args: f[a] )

`ValueForm`

type ValueForm

Constructors

AttachedToken
EqualsToken
SeparateToken

`ValueKind`

type ValueKind

Constructors

Flag
OptionalValue
RequiredValue

`ValueParser[a]`

type ValueParser[a: +*]

Constructors

ValueParser( parse_fn: String -> Zafu/Control/Result::Result[Zafu/Text/Pretty::Doc, a], metavar: Zafu/Text/Pretty::Doc, choices: Option[Zafu/Collection/NonEmptyList::NonEmptyList[(String, Zafu/Text/Pretty::Doc)]] )