clikt/com.github.ajalt.clikt.parameters.types

Package-level declarations

Properties

val InputStream.isCliktParameterDefaultStdin: Boolean

Checks whether this stream was returned from an inputStream parameter, and that it is reading from System. in (because - was given, or no value was given and the parameter uses defaultStdin).

isCliktParameterDefaultStdout

val OutputStream.isCliktParameterDefaultStdout: Boolean

Checks whether this stream was returned from an outputStream parameter, and that it is writing to System.out (because - was given, or no value was given and the parameter uses defaultStdout).

Functions

boolean

fun RawArgument.boolean(): ProcessedArgument<Boolean, Boolean>

Convert the argument values to Boolean.

fun RawOption.boolean(): NullableOption<Boolean, Boolean>

Convert the option values to Boolean

choice

fun <T : Any> RawArgument.choice(vararg choices: Pair<String, T>, ignoreCase: Boolean = false): ProcessedArgument<T, T>

fun <T : Any> RawArgument.choice(choices: Map<String, T>, ignoreCase: Boolean = false): ProcessedArgument<T, T>

Convert the argument based on a fixed set of values.

fun RawArgument.choice(vararg choices: String, ignoreCase: Boolean = false): ProcessedArgument<String, String>

Restrict the argument to a fixed set of values.

fun <T : Any> RawOption.choice(vararg choices: Pair<String, T>, metavar: String = mvar(choices.map { it.first }), ignoreCase: Boolean = false): NullableOption<T, T>

fun <T : Any> RawOption.choice(choices: Map<String, T>, metavar: String = mvar(choices.keys), ignoreCase: Boolean = false): NullableOption<T, T>

Convert the option based on a fixed set of values.

fun RawOption.choice(vararg choices: String, metavar: String = mvar(choices.asIterable()), ignoreCase: Boolean = false): NullableOption<String, String>

Restrict the option to a fixed set of values.

defaultStdin

fun ProcessedArgument<InputStream, InputStream>.defaultStdin(): ArgumentDelegate<InputStream>

Use - as the default value for an inputStream argument.

fun NullableOption<InputStream, InputStream>.defaultStdin(): OptionWithValues<InputStream, InputStream, InputStream>

Use - as the default value for an inputStream option.

defaultStdout

fun ProcessedArgument<OutputStream, OutputStream>.defaultStdout(): ArgumentDelegate<OutputStream>

Use - as the default value for an outputStream argument.

fun NullableOption<OutputStream, OutputStream>.defaultStdout(): OptionWithValues<OutputStream, OutputStream, OutputStream>

Use - as the default value for an outputStream option.

double

fun RawArgument.double(): ProcessedArgument<Double, Double>

Convert the argument values to a Double

fun RawOption.double(): OptionWithValues<Double?, Double, Double>

Convert the option values to a Double

enum

inline fun <T : Enum<T>> RawArgument.enum(ignoreCase: Boolean = true, key: (T) -> String = { it.name }): ProcessedArgument<T, T>

Convert the argument to the values of an enum.

inline fun <T : Enum<T>> RawOption.enum(ignoreCase: Boolean = true, key: (T) -> String = { it.name }): NullableOption<T, T>

Convert the option to the values of an enum.

file

fun RawArgument.file(mustExist: Boolean = false, canBeFile: Boolean = true, canBeDir: Boolean = true, mustBeWritable: Boolean = false, mustBeReadable: Boolean = false, canBeSymlink: Boolean = true): ProcessedArgument<File, File>

Convert the argument to a File.

fun RawOption.file(mustExist: Boolean = false, canBeFile: Boolean = true, canBeDir: Boolean = true, mustBeWritable: Boolean = false, mustBeReadable: Boolean = false, canBeSymlink: Boolean = true): NullableOption<File, File>

Convert the option to a File.

float

fun RawArgument.float(): ProcessedArgument<Float, Float>

Convert the argument values to a Float

fun RawOption.float(): OptionWithValues<Float?, Float, Float>

Convert the option values to a Float

inputStream

fun RawArgument.inputStream(fileSystem: FileSystem = FileSystems.getDefault()): ProcessedArgument<InputStream, InputStream>

Convert the argument to an InputStream.

fun RawOption.inputStream(fileSystem: FileSystem = FileSystems.getDefault()): NullableOption<InputStream, InputStream>

Convert the option to an InputStream.

int

fun RawArgument.int(): ProcessedArgument<Int, Int>

Convert the argument values to an Int

fun RawOption.int(acceptsValueWithoutName: Boolean = false): NullableOption<Int, Int>

Convert the option values to an Int

long

fun RawArgument.long(): ProcessedArgument<Long, Long>

Convert the argument values to a Long

fun RawOption.long(acceptsValueWithoutName: Boolean = false): NullableOption<Long, Long>

Convert the option values to an Long

outputStream

fun RawArgument.outputStream(createIfNotExist: Boolean = true, truncateExisting: Boolean = false, fileSystem: FileSystem = FileSystems.getDefault()): ProcessedArgument<OutputStream, OutputStream>

Convert the argument to an OutputStream.

fun RawOption.outputStream(createIfNotExist: Boolean = true, truncateExisting: Boolean = false, fileSystem: FileSystem = FileSystems.getDefault()): NullableOption<OutputStream, OutputStream>

Convert the option to an OutputStream.

path

fun RawArgument.path(mustExist: Boolean = false, canBeFile: Boolean = true, canBeDir: Boolean = true, mustBeWritable: Boolean = false, mustBeReadable: Boolean = false, canBeSymlink: Boolean = true, fileSystem: FileSystem = FileSystems.getDefault()): ProcessedArgument<Path, Path>

Convert the argument to a Path.

fun RawOption.path(mustExist: Boolean = false, canBeFile: Boolean = true, canBeDir: Boolean = true, mustBeWritable: Boolean = false, mustBeReadable: Boolean = false, canBeSymlink: Boolean = true, fileSystem: FileSystem = FileSystems.getDefault()): NullableOption<Path, Path>

Convert the option to a Path.

restrictTo

fun <T : Comparable<T>> ProcessedArgument<T, T>.restrictTo(range: ClosedRange<T>, clamp: Boolean = false): ProcessedArgument<T, T>

fun <T : Comparable<T>> ProcessedArgument<T, T>.restrictTo(min: T? = null, max: T? = null, clamp: Boolean = false): ProcessedArgument<T, T>

Restrict the argument values to fit into a range.

fun <T : Comparable<T>> OptionWithValues<T?, T, T>.restrictTo(range: ClosedRange<T>, clamp: Boolean = false): OptionWithValues<T?, T, T>

fun <T : Comparable<T>> OptionWithValues<T?, T, T>.restrictTo(min: T? = null, max: T? = null, clamp: Boolean = false): OptionWithValues<T?, T, T>

Restrict the option values to fit into a range.

uint

fun RawArgument.uint(): ProcessedArgument<UInt, UInt>

Convert the argument values to an UInt

fun RawOption.uint(acceptsValueWithoutName: Boolean = false): NullableOption<UInt, UInt>

Convert the option values to a UInt

ulong

fun RawArgument.ulong(): ProcessedArgument<ULong, ULong>

Convert the argument values to a ULong

fun RawOption.ulong(acceptsValueWithoutName: Boolean = false): NullableOption<ULong, ULong>

Convert the option values to a ULong