Packages

package 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.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. core
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Package Members

  1. package app
  2. package argparser

    Things related to parsing a single argument.

    Things related to parsing a single argument.

    Mostly revolves around caseapp.core.argparser.ArgParser.

  3. package commandparser

    Command parsing-related things.

    Command parsing-related things.

    Mostly revolves around caseapp.core.commandparser.CommandParser.

  4. package default
  5. package help
  6. package parser

    All-the-arguments parsing stuff.

    All-the-arguments parsing stuff.

    Mostly revolves around caseapp.core.parser.Parser.

  7. package util

Type Members

  1. final case class Arg(name: Name, extraNames: Seq[Name] = Nil, valueDescription: Option[ValueDescription] = None, helpMessage: Option[HelpMessage] = None, noHelp: Boolean = false, isFlag: Boolean = false) extends Product with Serializable

    Infos about an argument / option an application can accept.

  2. sealed abstract class Counter extends AnyRef

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

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

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

  3. sealed abstract class Error extends Product with Serializable

    Base type for errors during arguments parsing

  4. final case class RemainingArgs(remaining: Seq[String], unparsed: Seq[String]) extends Product with Serializable

    Arguments that don't correspond to options.

Value Members

  1. object Error extends Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped