package config
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- config
- ConfigStringModule
- ConfigSourceStringModule
- ConfigModule
- ReadModule
- ConfigDocsModule
- WriteModule
- ConfigDescriptorModule
- ConfigSourceModule
- KeyValueModule
- KeyConversionFunctions
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- Protected
Type Members
- sealed trait ConfigDescriptor[A] extends AnyRef
- Definition Classes
- ConfigDescriptorModule
- trait ConfigDescriptorFunctions extends AnyRef
- Definition Classes
- ConfigDescriptorModule
- sealed trait ConfigDocs extends AnyRef
- Definition Classes
- ConfigDocsModule
- trait ConfigSource extends AnyRef
- Definition Classes
- ConfigSourceModule
- trait ConfigSourceFunctions extends AnyRef
- Definition Classes
- ConfigSourceModule
- case class ConfigSourceName extends Product with Serializable
- Definition Classes
- ConfigSourceModule
- abstract type K
- Definition Classes
- KeyValueModule
- sealed trait LeafForSequence extends AnyRef
- Definition Classes
- ConfigSourceModule
- case class Table extends Product with Serializable
- Definition Classes
- ConfigDocsModule
- abstract type V
- Definition Classes
- KeyValueModule
- type ZConfig[A] = Has[A]
- Definition Classes
- ConfigModule
Value Members
- def addPrefix(prefix: String): (String) => String
- Definition Classes
- KeyConversionFunctions
- def camelToDelimiter(input: String, delimiter: String): String
- Definition Classes
- KeyConversionFunctions
- final def config[A](implicit tag: zio.Tag[A]): ZIO[ZConfig[A], Nothing, A]
- Definition Classes
- ConfigModule
- def foldReadError[B](error: ReadError[config.K])(alternative: B)(f: PartialFunction[ReadError[config.K], B])(g: (B, B) => B, zero: B): B
- Definition Classes
- ReadModule
- final def generateDocs[A](config: ConfigDescriptor[A]): ConfigDocs
- Definition Classes
- ConfigDocsModule
- def generateReport[A](config: ConfigDescriptor[A], value: A): Either[String, ConfigDocs]
- Definition Classes
- ConfigDocsModule
- def getConfigSource(sourceNames: Set[ConfigSourceName], getTree: (List[config.K]) => PropertyTree[config.K, config.V], isLeafValidSequence: LeafForSequence): ConfigSource
- Attributes
- protected
- Definition Classes
- ConfigSourceModule
- def handleDefaultValues[A, B](error: ReadError[config.K], config: ConfigDescriptor[A], default: B): Either[ReadError[config.K], AnnotatedRead[B]]
- Definition Classes
- ReadModule
- def parseErrorMessage(given: String, expectedType: String): String
- Definition Classes
- ReadModule
- def postFix(string: String): (String) => String
- Definition Classes
- KeyConversionFunctions
- final def read[A](configuration: ConfigDescriptor[A]): Either[ReadError[config.K], A]
- Definition Classes
- ReadModule
- final def requiredZipAndOrFields[A](config: ConfigDescriptor[A]): Int
- Definition Classes
- ReadModule
- def sizeOfZipAndOrErrors(error: ReadError[config.K]): Int
- Definition Classes
- ReadModule
- val toKebabCase: (String) => String
- Definition Classes
- KeyConversionFunctions
- val toSnakeCase: (String) => String
- Definition Classes
- KeyConversionFunctions
- final def write[A](config: ConfigDescriptor[A], a: A): Either[String, PropertyTree[config.K, config.V]]
- Definition Classes
- WriteModule
- object ConfigDescriptor extends config.ConfigStringModule.ConfigDescriptorFunctions
- Definition Classes
- ConfigStringModule
- object ConfigSource extends config.ConfigSourceStringModule.ConfigSourceFunctions
- Definition Classes
- ConfigSourceStringModule
Documentation for the EMuRestAPI server for EMu
Overview
The EMuRestAPI project, emurestapi provides an EMu REST API for EMu.
Documentation
The documentation consists of two sections:
The web site documentation provides complete descriptions of all API endpoints along with many examples showing how to use them. The scaladocs are for reference only with the web site to be preferred.