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

file

fun RawArgument.file(exists: Boolean = false, fileOkay: Boolean = true, folderOkay: Boolean = true, writable: Boolean = false, readable: Boolean = false): ProcessedArgument<File, File>

Convert the argument to a File.

Parameters

exists - If true, fail if the given path does not exist

fileOkay - If false, fail if the given path is a file

folderOkay - If false, fail if the given path is not a directory

writable - If false, fail of the given path is not writable

readable - If false, fail of the given path is not readable

fun RawOption.file(exists: Boolean = false, fileOkay: Boolean = true, folderOkay: Boolean = true, writable: Boolean = false, readable: Boolean = false): NullableOption<File, File>

Convert the option to a File.

Parameters

exists - If true, fail if the given path does not exist

fileOkay - If false, fail if the given path is a file

folderOkay - If false, fail if the given path is not a directory

writable - If false, fail of the given path is not writable

readable - If false, fail of the given path is not readable