Schema

io.hireproof.structure.Schema
See theSchema companion object
sealed abstract class Schema[A] extends Structure[A]

Attributes

Companion:
object
Graph
Supertypes
trait Structure[A]
class Object
trait Matchable
class Any
Known subtypes
class Optional[A]
class Value[A]
class Any[A]
class Collection[A]
class Dictionary[A]
class Enumeration[A]
class Primitive[A]
class Product[A]
class Sum[A]

Members list

Concise view

Type members

Types

override type Self[a] <: Schema[a]

Value members

Abstract methods

def default: Option[A]
def description: Option[String]
def example: Option[A]
def name: Option[String]
def toJson(a: A): Option[Json]
def toString(a: A): Option[String]
def validations: Chain[Validation[_, _]]

Concrete methods

final def fromJson(json: Option[Json]): Validated[Errors, A]
final def fromString(value: Option[String]): Validated[Errors, A]
final def jsonDefault: Option[Json]
final def jsonExample: Option[Json]
final def setDefault(default: Option[A]): Self[A]
final def setDescription(description: Option[String]): Self[A]
final def setExample(example: Option[A]): Self[A]
final def setName(description: Option[String]): Self[A]
final def stringDefault: Option[String]
final def stringExample: Option[String]
final def withDefault(default: A): Self[A]
final def withDescription(description: String): Self[A]
final def withExample(example: A): Self[A]
final def withName(description: String): Self[A]
final def withoutDefault: Self[A]
final def withoutDescription: Self[A]
final def withoutExample: Self[A]
final def withoutName: Self[A]

Inherited methods

final def const(value: => A): Self[Unit]

Attributes

Inherited from:
Structure
final def imap[T](f: A => T)(g: T => A): Self[T]

Attributes

Inherited from:
Structure
final def ivalidate[T](validation: Validation[A, T])(g: T => A): Self[T]

Attributes

Inherited from:
Structure
final def merge[T](implicit evidence: Aux[A, T]): Self[T]

Attributes

Inherited from:
Structure
final def validate(validation: Validation[A, A]): Self[A]

Attributes

Inherited from:
Structure