zio-schema/zio.schema/Schema/Collection

Collection

sealed trait Collection[Col, Elem] extends Schema[Col]
trait Schema[Col]
class Object
trait Matchable
class Any
class Map[K, V]
class Sequence[Col, Elem, I]
class Set[A]

Type members

Inherited types

type Accessors[Lens[_, _, _], Prism[_, _, _], Traversal[_, _]]
Inherited from:
Schema

Value members

Inherited methods

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

A symbolic operator for zip.

A symbolic operator for zip.

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

A symbolic operator for orElseEither.

A symbolic operator for orElseEither.

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

A symbolic operator for optional.

A symbolic operator for optional.

Inherited from:
Schema
def annotate(annotation: Any): Schema[Col]

Returns a new schema that with annotation

Returns a new schema that with annotation

Inherited from:
Schema
def annotations: Chunk[Any]

Chunk of annotations for this schema

Chunk of annotations for this schema

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 defaultValue: Either[String, Col]

The default value for a Schema of type A.

The default value for a Schema of type A.

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

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, Col]
Inherited from:
Schema
def migrate[B](newSchema: Schema[B]): Either[String, Col => 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[Col]]

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[Col, 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[Col]
Inherited from:
Schema
def patch(oldValue: Col, diff: Patch[Col]): Either[String, Col]

Patch value with a Patch.

Patch value with a Patch.

Inherited from:
Schema
def repeated: Schema[Chunk[Col]]
Inherited from:
Schema
def serializable: Schema[Schema[Col]]
Inherited from:
Schema
def toDynamic(value: Col): DynamicValue
Inherited from:
Schema
def transform[B](f: Col => B, g: B => Col)(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: Col => Either[String, B], g: B => Either[String, Col])(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: Col)(implicit schema: Schema[Col]): Chunk[ValidationError]
Inherited from:
Schema
def zip[B](that: Schema[B]): Schema[(Col, 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