zio-config/zio.config/ConfigDocsModule/Table/TableRow

TableRow

zio.config.ConfigDocsModule.Table.TableRow

case class TableRow(paths: List[FieldName], format: Option[Format], description: List[Description], nested: Option[Table], sources: Set[String])

A TableRow represents each row in a Table which is an intermediate light-weight structure produced from ConfigDocs. Table is more easier to be converted to formats such as Json, markdown or any custom format fo your choice.

Value parameters

description: : Description (zio-config in-built or user-provided) of the key (paths).
format: : The format of value of key (paths). Example: it can be a Primitive type (String, Int etc), or it can be complex structures as such as List or Map.
nested: : A TableRow can be pointed to a nested table that has the details of all the child paths that are under paths. Hence TableRow is a recursive structure.
paths: : Each config key is basically a list of paths representing its hierarchy. Example: "aws.ec2.instance.type" where list of paths is List("aws", "ec2", "instance", "type")
sources:: All the sources from which paths can be retrieved.

Attributes

Graph
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

TableRow

Value parameters

Attributes

Members list

Value members

Concrete methods

Inherited methods

Attributes

Attributes