Generated with

caseapp.core

Core types / classes of caseapp.

Not that in most use cases of caseapp, simply importing things right under caseapp, rather things from caseapp.core, should be enough.

This package is itself split in several sub-packages:

caseapp.core.argparser: things related to parsing a single argument value,
caseapp.core.parser: things related to parsing a sequence of arguments,
caseapp.core.commandparser: things related to parsing a sequence of arguments, handling commands,
caseapp.core.help: things related to help messages,
caseapp.core.app: helpers to create caseapp-based applications,
caseapp.core.default: helper to set / define a default value for a given type,
caseapp.core.util: utilities, mostly for internal use.

Attributes

Concise view

Infos about an argument / option an application can accept.

extraNames:: extra names
helpMessage:: help message for this argument (optional)
isFlag:: if true, passing an actual value to this argument is optional
name:: main name of the argument
noHelp:: if true, this argument should not appear in help messages
valueDescription:: description of its value (optional)
Companion:: object
Graph
Supertypes: trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Companion:: class
Graph
Supertypes: trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type: Arg.type

Helper to count how many times a flag argument is specified.

Should be used with Int and caseapp.@@, like Int @@ Counter.

Base type for errors during arguments parsing

Companion:: object
Graph
Supertypes: trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Known subtypes: class SeveralErrors
class SimpleError
class ArgumentAlreadySpecified
object ArgumentMissing.type
object CannotBeDisabled.type
class CommandNotFound
class MalformedValue
class Other
class ParsingArgument
class RequiredOptionNotSpecified
class UnrecognizedArgument
class UnrecognizedFlagValue

Companion:: object
Graph
Supertypes: trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Companion:: class
Graph
Supertypes: trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type: Indexed.type

Arguments that don't correspond to options.

remaining:: arguments before any --
unparsed:: arguments after a first --, if any
Graph
Supertypes: trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Generated with