cli/scala.cli.config/ConfigDb

ConfigDb

object ConfigDb
Companion:
class
class Object
trait Matchable
class Any

Type members

Classlikes

final class ConfigDbPermissionsError(path: Path, perms: PermSet) extends BuildException

Value members

Concrete methods

def apply(dbContent: Array[Byte], printablePath: Option[String]): Either[ConfigDbFormatError, ConfigDb]

Create a ConfigDb instance from binary content

Create a ConfigDb instance from binary content

Value parameters:
dbContent:

JSON, as a UTF-8 array of bytes

printablePath:

DB location, for error messages

Returns:

either an error on failure, or a ConfigDb instance on success

def dbPath(directories: Directories): Path
def defaultDbFileName: String
def open(path: Path): Either[BuildException, ConfigDb]

Creates a ConfigDb from a file

Creates a ConfigDb from a file

Value parameters:
path:

path to a config UTF-8 JSON file

Returns:

either an error on failure, or a ConfigDb instance on success

def open(directories: Directories): Either[BuildException, ConfigDb]

Creates a ConfigDb from Scala CLI directories

Creates a ConfigDb from Scala CLI directories

Value parameters:
directories:

a Scala CLI Directories instance

Returns:

either an error on failure, or a ConfigDb instance on success

def open(sharedOptions: SharedOptions): Either[BuildException, ConfigDb]

Creates a ConfigDb from Scala CLI scala.cli.commands.SharedOptions

Creates a ConfigDb from Scala CLI scala.cli.commands.SharedOptions

Value parameters:
sharedOptions:

a Scala CLI shared options instance

Returns:

either an error on failure, or a ConfigDb instance on success