Reference
std/args
std/args
A command line as data: flags, positionals and subcommands, parsed in one call.
narra
import * as Args from "std/args"
The guide teaches it in chapter 13, The standard library.
This page is generated by scripts/std/generate.nra from narrac query --json interface std/args. Do not edit it.
Types
Flag
narra
export struct Flag derives Show, Equatable {
name: string
short: string
value: string
repeated: bool
help: string
}
Rest
narra
export enum Rest derives Show, Equatable {
None
Positionals
Raw
}
Entry
narra
export struct Entry derives Show, Equatable {
name: string
value: string
}
Command
narra
export struct Command derives Show, Equatable {
name: string
summary: string
flags: Array<Flag>
positionals: Array<string>
rest: Rest
commands: Array<Command>
}
Parsed
narra
export struct Parsed derives Show, Equatable {
path: Array<string>
flags: Array<Entry>
positionals: Array<Entry>
rest: Array<string>
}
Functions: parse, has, value, values, positional, rest, commandPath.
ArgsError
narra
export enum ArgsError derives Show, Equatable {
UnknownFlag(name: string, closest: string)
MissingValue(flag: string)
UnexpectedValue(flag: string)
Repeated(flag: string)
UnknownCommand(name: string, closest: string)
MissingCommand(path: Array<string>)
MissingPositional(name: string)
ExtraPositional(text: string)
Help(path: Array<string>)
BadSpec(reason: string)
}
Functions: parse, formatError.
Functions
parse
narra
export function parse(command: Command, arguments: Array<string>): Result<Parsed, ArgsError> uses alloc
Effects: alloc.
has
narra
export function has(parsed: Parsed, name: string): bool
Effects: none.
value
narra
export function value(parsed: Parsed, name: string): Option<string> uses alloc
Effects: alloc.
values
narra
export function values(parsed: Parsed, name: string): Array<string> uses alloc
Effects: alloc.
positional
narra
export function positional(parsed: Parsed, name: string): Option<string> uses alloc
Effects: alloc.
rest
narra
export function rest(parsed: Parsed): Array<string> uses alloc
Effects: alloc.
commandPath
narra
export function commandPath(parsed: Parsed): Array<string> uses alloc
Effects: alloc.
help
narra
export function help(command: Command, path: Array<string>): string uses alloc
Effects: alloc.
formatError
narra
export function formatError(error: ArgsError): string uses alloc
Effects: alloc.