structure-core
API
Generated with
© 2002-2021 · LAMP/EPFL
© 2002-2021 · LAMP/EPFL
structure-core/io.hireproof.structure/Schema/Optional

Optional

io.hireproof.structure.Schema$.Optional
See theOptional companion object
sealed abstract class Optional[A](val default: Option[A], val schema: Schema[_], val example: Option[A]) extends Schema[A]

Attributes

Companion:
object
Graph
Supertypes
class Schema[A]
trait Structure[A]
class Object
trait Matchable
class Any
Self type

Members list

Concise view

Type members

Types

final override type Self[a] = Optional[a]

Value members

Concrete methods

final override def description: Option[String]

Attributes

Definition Classes
final override def name: Option[String]

Attributes

Definition Classes
final override def validations: Chain[Validation[_, _]]

Attributes

Definition Classes

Inherited methods

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

Attributes

Inherited from:
Structure
final def fromJson(json: Option[Json]): Validated[Errors, A]

Attributes

Inherited from:
Schema
final def fromString(value: Option[String]): Validated[Errors, A]

Attributes

Inherited from:
Schema
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 jsonDefault: Option[Json]

Attributes

Inherited from:
Schema
final def jsonExample: Option[Json]

Attributes

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

Attributes

Inherited from:
Structure
final def setDefault(default: Option[A]): Self[A]

Attributes

Inherited from:
Schema
final def setDescription(description: Option[String]): Self[A]

Attributes

Inherited from:
Schema
final def setExample(example: Option[A]): Self[A]

Attributes

Inherited from:
Schema
final def setName(description: Option[String]): Self[A]

Attributes

Inherited from:
Schema
final def stringDefault: Option[String]

Attributes

Inherited from:
Schema
final def stringExample: Option[String]

Attributes

Inherited from:
Schema
def toJson(a: A): Option[Json]

Attributes

Inherited from:
Schema
def toString(a: A): Option[String]

Attributes

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

Attributes

Inherited from:
Structure
final def withDefault(default: A): Self[A]

Attributes

Inherited from:
Schema
final def withDescription(description: String): Self[A]

Attributes

Inherited from:
Schema
final def withExample(example: A): Self[A]

Attributes

Inherited from:
Schema
final def withName(description: String): Self[A]

Attributes

Inherited from:
Schema
final def withoutDefault: Self[A]

Attributes

Inherited from:
Schema
final def withoutDescription: Self[A]

Attributes

Inherited from:
Schema
final def withoutExample: Self[A]

Attributes

Inherited from:
Schema
final def withoutName: Self[A]

Attributes

Inherited from:
Schema

Concrete fields

override val default: Option[A]
override val example: Option[A]
val schema: Schema[_]
Generated with
© 2002-2021 · LAMP/EPFL
© 2002-2021 · LAMP/EPFL