config
API
Generated with
config/scala.cli.config/Key/KeyWithJsonCodec

KeyWithJsonCodec

scala.cli.config.Key$.KeyWithJsonCodec
abstract class KeyWithJsonCodec[T](implicit jsonCodec: JsonValueCodec[T]) extends Key[T]

Attributes

Graph
Supertypes
class Key[T]
class Object
trait Matchable
class Any
Known subtypes
class BooleanEntry
class StringEntry

Members list

Value members

Concrete methods

def parse(json: Array[Byte]): Either[EntryError, T]

Try to parse a value of this key

Try to parse a value of this key

Attributes

def write(value: T): Array[Byte]

Converts a value of this key to JSON

Converts a value of this key to JSON

Attributes

Returns

UTF-8 encoded JSON

Inherited methods

def asString(value: T): Seq[String]

Converts a value of this key to a sequence of strings

Converts a value of this key to a sequence of strings

Such a sequence can be printed in the console, and converted back to a T with fromString.

Attributes

Inherited from:
Key
def description: String

A short description of a particular key's purpose and syntax for its values.

A short description of a particular key's purpose and syntax for its values.

Attributes

Inherited from:
Key
def fromString(values: Seq[String]): Either[MalformedValue, T]

Reads a value of this key from a sequence of string

Reads a value of this key from a sequence of string

Attributes

Inherited from:
Key
final def fullName: String

The fully qualified name of this key

The fully qualified name of this key

Attributes

Inherited from:
Key
def hidden: Boolean

A flag indicating whether the key should by default be hidden in help outputs or not.

A flag indicating whether the key should by default be hidden in help outputs or not.

Attributes

Inherited from:
Key
def isExperimental: Boolean

Attributes

Inherited from:
Key
def isPasswordOption: Boolean

Whether this key corresponds to a password (see Key.PasswordEntry)

Whether this key corresponds to a password (see Key.PasswordEntry)

Attributes

Inherited from:
Key
def isRestricted: Boolean

Attributes

Inherited from:
Key
def name: String

Key name, such as "b" in "foo.a.b"

Key name, such as "b" in "foo.a.b"

Attributes

Inherited from:
Key
def prefix: Seq[String]

Key prefix, such as "foo.a" in "foo.a.b"

Key prefix, such as "foo.a" in "foo.a.b"

Attributes

Inherited from:
Key
def specificationLevel: SpecificationLevel

The SpecificationLevel of the key. SpecificationLevel.RESTRICTED && SpecificationLevel.EXPERIMENTAL keys are only available in power mode.

The SpecificationLevel of the key. SpecificationLevel.RESTRICTED && SpecificationLevel.EXPERIMENTAL keys are only available in power mode.

Attributes

Inherited from:
Key
Generated with