zio-schema/zio.schema/Schema/Optional

Optional

final case class Optional[A](schema: Schema[A], annotations: Chunk[Any]) extends Schema[Option[A]]
trait Serializable
trait Product
trait Equals
trait Schema[Option[A]]
class Object
trait Matchable
class Any

Type members

Types

override type Accessors[Lens[_, _, _], Prism[_, _, _], Traversal[_, _]] = (Prism[String, Option[A], Some[A]], Prism[String, Option[A], None.type])
type OptionalType = A

Value members

Concrete methods

override def annotate(annotation: Any): Optional[A]
Definition Classes
def defaultValue: Either[String, Option[A]]
override def makeAccessors(b: AccessorBuilder): (Prism[String, Option[A], Some[A]], Prism[String, Option[A], None.type])
Definition Classes

Inherited methods

def <*>[B](that: Schema[B]): Schema[(Option[A], B)]

A symbolic operator for zip.

A symbolic operator for zip.

Inherited from:
Schema
def <+>[B](that: Schema[B]): Schema[Either[Option[A], B]]

A symbolic operator for orElseEither.

A symbolic operator for orElseEither.

Inherited from:
Schema
def ?: Schema[Option[Option[A]]]

A symbolic operator for optional.

A symbolic operator for optional.

Inherited from:
Schema
def ast: MetaSchema
Inherited from:
Schema
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,_]

Inherited from:
Schema
def diff(thisValue: Option[A], thatValue: Option[A]): Patch[Option[A]]

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

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

Inherited from:
Schema
def fromDynamic(value: DynamicValue): Either[String, Option[A]]
Inherited from:
Schema
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

Inherited from:
Schema
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.

Inherited from:
Schema
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.

Inherited from:
Schema
def ordering: Ordering[Option[A]]
Inherited from:
Schema
def patch(oldValue: Option[A], diff: Patch[Option[A]]): Either[String, Option[A]]

Patch value with a Patch.

Patch value with a Patch.

Inherited from:
Schema
def productElementNames: Iterator[String]
Inherited from:
Product
def productIterator: Iterator[Any]
Inherited from:
Product
def repeated: Schema[Chunk[Option[A]]]
Inherited from:
Schema
def serializable: Schema[Schema[Option[A]]]
Inherited from:
Schema
def toDynamic(value: Option[A]): DynamicValue
Inherited from:
Schema
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.

Inherited from:
Schema
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).

Inherited from:
Schema
def validate(value: Option[A])(implicit schema: Schema[Option[A]]): Chunk[ValidationError]
Inherited from:
Schema
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.

Inherited from:
Schema

Concrete fields

val none: String
val some: String
lazy val toEnum: Enum2[Some[A], None.type, Option[A]]