c

zio.schema.Schema

Optional

final case class Optional[A](codec: Schema[A], annotations: Chunk[Any] = Chunk.empty) extends Schema[Option[A]] with Product with Serializable

Self Type
Optional[A]
Linear Supertypes
Serializable, Serializable, Product, Equals, Schema[Option[A]], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Optional
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Schema
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Optional(codec: Schema[A], annotations: Chunk[Any] = Chunk.empty)

Type Members

  1. type Accessors[Lens[_, _, _], Prism[_, _, _], Traversal[_, _]] = (Prism[some.type, Option[A], Some[A]], Prism[none.type, Option[A], None.type])
    Definition Classes
    Optional → Schema

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def <*>[B](that: Schema[B]): Schema[(Option[A], B)]

    A symbolic operator for zip.

    A symbolic operator for zip.

    Definition Classes
    Schema
  4. def <+>[B](that: Schema[B]): Schema[Either[Option[A], B]]

    A symbolic operator for orElseEither.

    A symbolic operator for orElseEither.

    Definition Classes
    Schema
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def ?: Schema[Option[Option[A]]]

    A symbolic operator for optional.

    A symbolic operator for optional.

    Definition Classes
    Schema
  7. def annotate(annotation: Any): Optional[A]

    Returns a new schema that with annotation

    Returns a new schema that with annotation

    Definition Classes
    Optional → Schema
  8. val annotations: Chunk[Any]

    Chunk of annotations for this schema

    Chunk of annotations for this schema

    Definition Classes
    Optional → Schema
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. def ast: SchemaAst
    Definition Classes
    Schema
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  12. val codec: Schema[A]
  13. def coerce[B](newSchema: Schema[B]): Either[String, Schema[B]]

    Convert to Schema[B] iff B and A are homomorphic.

    Convert to Schema[B] iff B and A are homomorphic.

    This can be used to e.g convert between a case class and it's "generic" representation as a ListMap[String,_]

    Definition Classes
    Schema
  14. def defaultValue: Either[String, Option[A]]

    The default value for a Schema of type A.

    The default value for a Schema of type A.

    Definition Classes
    Optional → Schema
  15. def diff(thisValue: Option[A], thatValue: Option[A], differ: Option[Differ[Option[A]]] = None): Diff[Option[A]]

    Performs a diff between thisValue and thatValue.

    Performs a diff between thisValue and thatValue. See zio.schema.Differ for details on the default diff algorithms.

    A custom zio.schema.Differ can be supplied if the default behavior is not acceptable.

    Definition Classes
    Schema
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. def fromDynamic(value: DynamicValue): Either[String, Option[A]]
    Definition Classes
    Schema
  19. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. def makeAccessors(b: AccessorBuilder): (Prism[some.type, Option[A], Some[A]], Prism[none.type, Option[A], None.type])
    Definition Classes
    Optional → Schema
  22. def migrate[B](newSchema: Schema[B]): Either[String, (Option[A]) ⇒ Either[String, B]]

    Generate a homomorphism from A to B iff A and B are homomorphic

    Generate a homomorphism from A to B iff A and B are homomorphic

    Definition Classes
    Schema
  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. val none: String
  25. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  26. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  27. def optional: Schema[Option[Option[A]]]

    Returns a new schema that modifies the type produced by this schema to be optional.

    Returns a new schema that modifies the type produced by this schema to be optional.

    Definition Classes
    Schema
  28. def orElseEither[B](that: Schema[B]): Schema[Either[Option[A], B]]

    Returns a new schema that combines this schema and the specified schema together, modeling their either composition.

    Returns a new schema that combines this schema and the specified schema together, modeling their either composition.

    Definition Classes
    Schema
  29. def ordering: Ordering[Option[A]]
    Definition Classes
    Schema
  30. def patch(oldValue: Option[A], diff: Diff[Option[A]]): Either[String, Option[A]]

    Patch value with a Diff.

    Patch value with a Diff.

    Definition Classes
    Schema
  31. def repeated: Schema[Chunk[Option[A]]]
    Definition Classes
    Schema
  32. def serializable: Schema[Schema[Option[A]]]
    Definition Classes
    Schema
  33. val some: String
  34. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  35. def toDynamic(value: Option[A]): DynamicValue
    Definition Classes
    Schema
  36. lazy val toEnum: Enum2[Some[A], None.type, Option[A]]
  37. def toSemiDynamic: Schema[(Option[A], Schema[Option[A]])]
    Definition Classes
    Schema
  38. def transform[B](f: (Option[A]) ⇒ B, g: (B) ⇒ Option[A])(implicit loc: SourceLocation): Schema[B]

    Transforms this Schema[A] into a Schema[B], by supplying two functions that can transform between A and B, without possibility of failure.

    Transforms this Schema[A] into a Schema[B], by supplying two functions that can transform between A and B, without possibility of failure.

    Definition Classes
    Schema
  39. def transformOrFail[B](f: (Option[A]) ⇒ Either[String, B], g: (B) ⇒ Either[String, Option[A]])(implicit loc: SourceLocation): Schema[B]

    Transforms this Schema[A] into a Schema[B], by supplying two functions that can transform between A and B (possibly failing in some cases).

    Transforms this Schema[A] into a Schema[B], by supplying two functions that can transform between A and B (possibly failing in some cases).

    Definition Classes
    Schema
  40. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  41. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  42. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  43. def zip[B](that: Schema[B]): Schema[(Option[A], B)]

    Returns a new schema that combines this schema and the specified schema together, modeling their tuple composition.

    Returns a new schema that combines this schema and the specified schema together, modeling their tuple composition.

    Definition Classes
    Schema

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Schema[Option[A]]

Inherited from AnyRef

Inherited from Any

Ungrouped